Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_PlanDefinition_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-PlanDefinition 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..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. PlanDefinition.implicitRules
Definition

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

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.

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

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. PlanDefinition.extension
Definition

An Extension


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

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
Alternate Namesextensions, user content
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:versionAlgorithm
    Slice NameversionAlgorithm
    Definition

    R5: PlanDefinition.versionAlgorithm[x] (new:Coding, string)

    ShortR5: How to compare versions (new)
    Comments

    Element PlanDefinition.versionAlgorithm[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm)
    8. PlanDefinition.extension:subtitle
    Slice Namesubtitle
    Definition

    R5: PlanDefinition.subtitle (new:string)

    ShortR5: Subordinate title of the plan definition (new)
    Comments

    Element PlanDefinition.subtitle has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subtitle has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Subordinate title of the plan definition (new)) (Extension Type: string)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. PlanDefinition.extension:subject
    Slice Namesubject
    Definition

    R5: PlanDefinition.subject[x] (new:canonical(EvidenceVariable), CodeableConcept, Reference(Group,MedicinalProductDefinition,SubstanceDefinition,AdministrableProductDefinition,ManufacturedItemDefinition,PackagedProductDefinition))

    ShortR5: Type of individual the plan definition is focused on (new)
    Comments

    Element PlanDefinition.subject[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subject[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. PlanDefinition.extension:copyrightLabel
    Slice NamecopyrightLabel
    Definition

    R5: PlanDefinition.copyrightLabel (new:string)

    ShortR5: Copyright holder and year(s) (new)
    Comments

    Element PlanDefinition.copyrightLabel has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel)
    14. PlanDefinition.extension:actor
    Slice Nameactor
    Definition

    R5: PlanDefinition.actor (new:BackboneElement)

    ShortR5: Actors within the plan (new)
    Comments

    Element PlanDefinition.actor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.actor has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Actors within the plan (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. PlanDefinition.extension:asNeeded
    Slice NameasNeeded
    Definition

    R5: PlanDefinition.asNeeded[x] (new:boolean, CodeableConcept)

    ShortR5: Preconditions for service (new)
    Comments

    Element PlanDefinition.asNeeded[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.asNeeded[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. PlanDefinition.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    20. 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 vs. not.
    This is labeled as "Is Modifier" because applications should not use a retired plan definition without due consideration.

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

    The lifecycle status of a Value Set or Concept Map.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    22. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production.

    Control0..1
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    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.

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

    0. PlanDefinition
    2. PlanDefinition.extension
    Control0..*
    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:versionAlgorithm
      Slice NameversionAlgorithm
      Definition

      R5: PlanDefinition.versionAlgorithm[x] (new:Coding, string)

      ShortR5: How to compare versions (new)
      Comments

      Element PlanDefinition.versionAlgorithm[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

      Control0..1
      TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm)
      6. PlanDefinition.extension:subtitle
      Slice Namesubtitle
      Definition

      R5: PlanDefinition.subtitle (new:string)

      ShortR5: Subordinate title of the plan definition (new)
      Comments

      Element PlanDefinition.subtitle has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subtitle has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: Subordinate title of the plan definition (new)) (Extension Type: string)
      8. PlanDefinition.extension:subject
      Slice Namesubject
      Definition

      R5: PlanDefinition.subject[x] (new:canonical(EvidenceVariable), CodeableConcept, Reference(Group,MedicinalProductDefinition,SubstanceDefinition,AdministrableProductDefinition,ManufacturedItemDefinition,PackagedProductDefinition))

      ShortR5: Type of individual the plan definition is focused on (new)
      Comments

      Element PlanDefinition.subject[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subject[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

      Control0..1
      TypeExtension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic))
      10. PlanDefinition.extension:copyrightLabel
      Slice NamecopyrightLabel
      Definition

      R5: PlanDefinition.copyrightLabel (new:string)

      ShortR5: Copyright holder and year(s) (new)
      Comments

      Element PlanDefinition.copyrightLabel has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

      Control0..1
      TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel)
      12. PlanDefinition.extension:actor
      Slice Nameactor
      Definition

      R5: PlanDefinition.actor (new:BackboneElement)

      ShortR5: Actors within the plan (new)
      Comments

      Element PlanDefinition.actor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.actor has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: Actors within the plan (new)) (Complex Extension)
      14. PlanDefinition.extension:asNeeded
      Slice NameasNeeded
      Definition

      R5: PlanDefinition.asNeeded[x] (new:boolean, CodeableConcept)

      ShortR5: Preconditions for service (new)
      Comments

      Element PlanDefinition.asNeeded[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.asNeeded[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept)
      16. PlanDefinition.contributor
      18. PlanDefinition.contributor.extension
      Control0..*
      SlicingThis element introduces a set of slices on PlanDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 20. PlanDefinition.contributor.extension:author
        Slice Nameauthor
        Definition

        R5: PlanDefinition.author additional types (ContactDetail) additional types from child elements (name, telecom)

        ShortR5: Who authored the content additional types
        Comments

        Element PlanDefinition.author is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.author do not cover the following types: ContactDetail. The mappings for PlanDefinition.author do not cover the following types based on type expansion: name, telecom.

        Control0..*
        TypeExtension(R5: Who authored the content additional types) (Complex Extension)
        22. PlanDefinition.contributor.extension:editor
        Slice Nameeditor
        Definition

        R5: PlanDefinition.editor additional types (ContactDetail) additional types from child elements (name, telecom)

        ShortR5: Who edited the content additional types
        Comments

        Element PlanDefinition.editor is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.editor do not cover the following types: ContactDetail. The mappings for PlanDefinition.editor do not cover the following types based on type expansion: name, telecom.

        Control0..*
        TypeExtension(R5: Who edited the content additional types) (Complex Extension)
        24. PlanDefinition.contributor.extension:reviewer
        Slice Namereviewer
        Definition

        R5: PlanDefinition.reviewer additional types (ContactDetail) additional types from child elements (name, telecom)

        ShortR5: Who reviewed the content additional types
        Comments

        Element PlanDefinition.reviewer is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.reviewer do not cover the following types: ContactDetail. The mappings for PlanDefinition.reviewer do not cover the following types based on type expansion: name, telecom. See guidance around (not) making local changes to elements here.

        Control0..*
        TypeExtension(R5: Who reviewed the content additional types) (Complex Extension)
        26. PlanDefinition.contributor.extension:endorser
        Slice Nameendorser
        Definition

        R5: PlanDefinition.endorser additional types (ContactDetail) additional types from child elements (name, telecom)

        ShortR5: Who endorsed the content additional types
        Comments

        Element PlanDefinition.endorser is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.endorser do not cover the following types: ContactDetail. The mappings for PlanDefinition.endorser do not cover the following types based on type expansion: name, telecom. See guidance around (not) making local changes to elements here.

        Control0..*
        TypeExtension(R5: Who endorsed the content additional types) (Complex Extension)
        28. PlanDefinition.contact
        30. PlanDefinition.contact.extension
        Control0..*
        SlicingThis element introduces a set of slices on PlanDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 32. PlanDefinition.contact.extension:contact
          Slice Namecontact
          Definition

          R5: PlanDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

          ShortR5: contact additional types
          Comments

          Element PlanDefinition.contact is mapped to FHIR STU3 element PlanDefinition.contact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.contact do not cover the following types: ContactDetail. The mappings for PlanDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

          See guidance around (not) making local changes to elements here.

          Control0..*
          TypeExtension(R5: contact additional types) (Complex Extension)
          34. PlanDefinition.library
          36. PlanDefinition.library.extension
          Control0..*
          SlicingThis element introduces a set of slices on PlanDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 38. PlanDefinition.library.extension:library
            Slice Namelibrary
            Definition

            R5: PlanDefinition.library additional types (canonical(http://hl7.org/fhir/StructureDefinition/Library)) additional types from child elements (value)

            ShortR5: library additional types
            Comments

            Element PlanDefinition.library is mapped to FHIR STU3 element PlanDefinition.library as SourceIsBroaderThanTarget. The mappings for PlanDefinition.library do not cover the following types: canonical. The mappings for PlanDefinition.library do not cover the following types based on type expansion: value.

            Control0..*
            TypeExtension(R5: library additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library))
            40. PlanDefinition.goal
            42. PlanDefinition.goal.target
            44. PlanDefinition.goal.target.extension
            Control0..*
            SlicingThis element introduces a set of slices on PlanDefinition.goal.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 46. PlanDefinition.goal.target.extension:detail
              Slice Namedetail
              Definition

              R5: PlanDefinition.goal.target.detail[x] additional types (string, boolean, integer, Ratio)

              ShortR5: detail additional types
              Comments

              Element PlanDefinition.goal.target.detail[x] is mapped to FHIR STU3 element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: boolean, integer, Ratio, string. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

              Control0..1
              TypeExtension(R5: detail additional types) (Extension Type: Choice of: string, boolean, integer, Ratio)
              48. PlanDefinition.action
              50. PlanDefinition.action.extension
              Control0..*
              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:linkId
                Slice NamelinkId
                Definition

                R5: PlanDefinition.action.linkId (new:string)

                ShortR5: Unique id for the action in the PlanDefinition (new)
                Comments

                Element PlanDefinition.action.linkId has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.linkId has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                Control0..1
                TypeExtension(R5: Unique id for the action in the PlanDefinition (new)) (Extension Type: string)
                54. PlanDefinition.action.extension:priority
                Slice Namepriority
                Definition

                R5: PlanDefinition.action.priority (new:code)

                ShortR5: routine | urgent | asap | stat (new)
                Comments

                Element PlanDefinition.action.priority has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.priority has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                Control0..1
                TypeExtension(R5: routine | urgent | asap | stat (new)) (Extension Type: code)
                56. PlanDefinition.action.extension:subject
                Slice Namesubject
                Definition

                R5: PlanDefinition.action.subject[x] (new:canonical, CodeableConcept, Reference(Group))

                ShortR5: Type of individual the action is focused on (new)
                Comments

                Element PlanDefinition.action.subject[x] has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.subject[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
                TypeExtension(R5: Type of individual the action is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group), uri)
                58. PlanDefinition.action.extension:timing
                Slice Nametiming
                Definition

                R5: PlanDefinition.action.timing[x] additional types (Age)

                ShortR5: timing additional types
                Comments

                Element PlanDefinition.action.timing[x] is mapped to FHIR STU3 element PlanDefinition.action.timing[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.timing[x] do not cover the following types: Age. The target context PlanDefinition.action.timing[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.action. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

                Control0..1
                TypeExtension(R5: timing additional types) (Extension Type: Age)
                60. PlanDefinition.action.extension:location
                Slice Namelocation
                Definition

                R5: PlanDefinition.action.location (new:CodeableReference(Location))

                ShortR5: Where it should happen (new)
                Comments

                Element PlanDefinition.action.location has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.location has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). May reference a specific clinical location or may just identify a type of location.

                Control0..1
                TypeExtension(R5: Where it should happen (new)) (Complex Extension)
                62. PlanDefinition.action.input
                64. PlanDefinition.action.input.extension
                Control0..*
                SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 66. PlanDefinition.action.input.extension:title
                  Slice Nametitle
                  Definition

                  R5: PlanDefinition.action.input.title (new:string)

                  ShortR5: User-visible title (new)
                  Comments

                  Element PlanDefinition.action.input.title has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                  Control0..1
                  TypeExtension(R5: User-visible title (new)) (Extension Type: string)
                  68. PlanDefinition.action.input.extension:requirement
                  Slice Namerequirement
                  Definition

                  R5: PlanDefinition.action.input.requirement (new:DataRequirement)

                  ShortR5: What data is provided (new)
                  Comments

                  Element PlanDefinition.action.input.requirement has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.requirement has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                  Control0..1
                  TypeExtension(R5: What data is provided (new)) (Complex Extension)
                  70. PlanDefinition.action.input.extension:relatedData
                  Slice NamerelatedData
                  Definition

                  R5: PlanDefinition.action.input.relatedData (new:id)

                  ShortR5: What data is provided (new)
                  Comments

                  Element PlanDefinition.action.input.relatedData has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.relatedData has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

                  Control0..1
                  TypeExtension(R5: What data is provided (new)) (Extension Type: id)
                  72. PlanDefinition.action.output
                  74. PlanDefinition.action.output.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 76. PlanDefinition.action.output.extension:title
                    Slice Nametitle
                    Definition

                    R5: PlanDefinition.action.output.title (new:string)

                    ShortR5: User-visible title (new)
                    Comments

                    Element PlanDefinition.action.output.title has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                    Control0..1
                    TypeExtension(R5: User-visible title (new)) (Extension Type: string)
                    78. PlanDefinition.action.output.extension:requirement
                    Slice Namerequirement
                    Definition

                    R5: PlanDefinition.action.output.requirement (new:DataRequirement)

                    ShortR5: What data is provided (new)
                    Comments

                    Element PlanDefinition.action.output.requirement has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.requirement has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                    Control0..1
                    TypeExtension(R5: What data is provided (new)) (Complex Extension)
                    80. PlanDefinition.action.output.extension:relatedData
                    Slice NamerelatedData
                    Definition

                    R5: PlanDefinition.action.output.relatedData (new:string)

                    ShortR5: What data is provided (new)
                    Comments

                    Element PlanDefinition.action.output.relatedData has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.relatedData has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

                    Control0..1
                    TypeExtension(R5: What data is provided (new)) (Extension Type: string)
                    82. PlanDefinition.action.participant
                    84. PlanDefinition.action.participant.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on PlanDefinition.action.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 86. PlanDefinition.action.participant.extension:actorId
                      Slice NameactorId
                      Definition

                      R5: PlanDefinition.action.participant.actorId (new:string)

                      ShortR5: What actor (new)
                      Comments

                      Element PlanDefinition.action.participant.actorId has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.actorId has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                      Control0..1
                      TypeExtension(R5: What actor (new)) (Extension Type: string)
                      88. PlanDefinition.action.participant.extension:typeCanonical
                      Slice NametypeCanonical
                      Definition

                      R5: PlanDefinition.action.participant.typeCanonical (new:canonical(CapabilityStatement))

                      ShortR5: Who or what can participate (new)
                      Comments

                      Element PlanDefinition.action.participant.typeCanonical has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.typeCanonical has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                      Control0..1
                      TypeExtension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement))
                      90. PlanDefinition.action.participant.extension:typeReference
                      Slice NametypeReference
                      Definition

                      R5: PlanDefinition.action.participant.typeReference (new:Reference(CareTeam,Device,DeviceDefinition,Endpoint,Group,HealthcareService,Location,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson))

                      ShortR5: Who or what can participate (new)
                      Comments

                      Element PlanDefinition.action.participant.typeReference has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.typeReference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

                      Control0..1
                      TypeExtension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson))
                      92. PlanDefinition.action.participant.extension:function
                      Slice Namefunction
                      Definition

                      R5: PlanDefinition.action.participant.function (new:CodeableConcept)

                      ShortR5: E.g. Author, Reviewer, Witness, etc (new)
                      Comments

                      Element PlanDefinition.action.participant.function has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.function has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                      Control0..1
                      TypeExtension(R5: E.g. Author, Reviewer, Witness, etc (new)) (Extension Type: CodeableConcept)
                      94. PlanDefinition.action.participant.type
                      96. PlanDefinition.action.participant.type.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on PlanDefinition.action.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 98. PlanDefinition.action.participant.type.extension:type
                        Slice Nametype
                        Definition

                        R5: PlanDefinition.action.participant.type

                        ShortR5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                        Comments

                        Element PlanDefinition.action.participant.type is mapped to FHIR STU3 element PlanDefinition.action.participant.type as SourceIsBroaderThanTarget.

                        Control0..1
                        TypeExtension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (Extension Type: code)
                        100. PlanDefinition.action.type
                        102. PlanDefinition.action.type.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on PlanDefinition.action.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 104. PlanDefinition.action.type.extension:type
                          Slice Nametype
                          Definition

                          R5: PlanDefinition.action.type additional types (CodeableConcept) additional types from child elements (text)

                          ShortR5: type additional types
                          Comments

                          Element PlanDefinition.action.type is mapped to FHIR STU3 element PlanDefinition.action.type as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.type do not cover the following types: CodeableConcept. The mappings for PlanDefinition.action.type do not cover the following types based on type expansion: text.

                          Control0..1
                          TypeExtension(R5: type additional types) (Extension Type: CodeableConcept)
                          106. PlanDefinition.action.definition
                          108. PlanDefinition.action.definition.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on PlanDefinition.action.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 110. PlanDefinition.action.definition.extension:definition
                            Slice Namedefinition
                            Definition

                            R5: PlanDefinition.action.definition[x] additional types (canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/MessageDefinition), canonical(http://hl7.org/fhir/StructureDefinition/ObservationDefinition), canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/SpecimenDefinition), uri)

                            ShortR5: definition additional types
                            Comments

                            Element PlanDefinition.action.definition[x] is mapped to FHIR STU3 element PlanDefinition.action.definition as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.definition[x] do not cover the following types: canonical, uri. 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
                            TypeExtension(R5: definition additional types) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.MessageDefinition for use in FHIR STU3, MessageDefinition, Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R5.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic))
                            112. PlanDefinition.action.transform
                            114. PlanDefinition.action.transform.extension
                            Control0..*
                            SlicingThis element introduces a set of slices on PlanDefinition.action.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 116. PlanDefinition.action.transform.extension:transform
                              Slice Nametransform
                              Definition

                              R5: PlanDefinition.action.transform additional types (canonical(http://hl7.org/fhir/StructureDefinition/StructureMap)) additional types from child elements (value)

                              ShortR5: transform additional types
                              Comments

                              Element PlanDefinition.action.transform is mapped to FHIR STU3 element PlanDefinition.action.transform as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.transform do not cover the following types: canonical. The mappings for PlanDefinition.action.transform do not cover the following types based on type expansion: value. 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
                              TypeExtension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap))

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

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

                              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
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              4. PlanDefinition.meta
                              Definition

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

                              ShortMetadata about the resource
                              Control0..1
                              TypeMeta
                              Summarytrue
                              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.

                              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.

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

                              Control0..1
                              Typeuri
                              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              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
                              BindingUnless not suitable, these codes SHALL be taken from Common Languages .
                              (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                              A human language.

                              Additional BindingsPurpose
                              All LanguagesMax Binding
                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              10. PlanDefinition.text
                              Definition

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

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

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

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

                              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.

                              Control0..*
                              TypeResource
                              Alternate Namesinline resources, anonymous resources, contained resources
                              14. PlanDefinition.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              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:versionAlgorithm
                                Slice NameversionAlgorithm
                                Definition

                                R5: PlanDefinition.versionAlgorithm[x] (new:Coding, string)

                                ShortR5: How to compare versions (new)
                                Comments

                                Element PlanDefinition.versionAlgorithm[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

                                Control0..1
                                TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm)
                                18. PlanDefinition.extension:subtitle
                                Slice Namesubtitle
                                Definition

                                R5: PlanDefinition.subtitle (new:string)

                                ShortR5: Subordinate title of the plan definition (new)
                                Comments

                                Element PlanDefinition.subtitle has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subtitle has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R5: Subordinate title of the plan definition (new)) (Extension Type: string)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                20. PlanDefinition.extension:subject
                                Slice Namesubject
                                Definition

                                R5: PlanDefinition.subject[x] (new:canonical(EvidenceVariable), CodeableConcept, Reference(Group,MedicinalProductDefinition,SubstanceDefinition,AdministrableProductDefinition,ManufacturedItemDefinition,PackagedProductDefinition))

                                ShortR5: Type of individual the plan definition is focused on (new)
                                Comments

                                Element PlanDefinition.subject[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.subject[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic))
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                22. PlanDefinition.extension:copyrightLabel
                                Slice NamecopyrightLabel
                                Definition

                                R5: PlanDefinition.copyrightLabel (new:string)

                                ShortR5: Copyright holder and year(s) (new)
                                Comments

                                Element PlanDefinition.copyrightLabel has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element PlanDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

                                Control0..1
                                TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel)
                                24. PlanDefinition.extension:actor
                                Slice Nameactor
                                Definition

                                R5: PlanDefinition.actor (new:BackboneElement)

                                ShortR5: Actors within the plan (new)
                                Comments

                                Element PlanDefinition.actor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.actor has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                Control0..*
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R5: Actors within the plan (new)) (Complex Extension)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                26. PlanDefinition.extension:asNeeded
                                Slice NameasNeeded
                                Definition

                                R5: PlanDefinition.asNeeded[x] (new:boolean, CodeableConcept)

                                ShortR5: Preconditions for service (new)
                                Comments

                                Element PlanDefinition.asNeeded[x] has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.asNeeded[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                28. PlanDefinition.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                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 No Modifier Reason provideed in previous versions of FHIR
                                Alternate Namesextensions, user content
                                30. PlanDefinition.url
                                Definition

                                An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see Technical and Business Versions.

                                ShortLogical URI to reference this plan definition (globally unique)
                                Comments

                                Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.

                                Control0..1
                                Typeuri
                                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.

                                32. 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, e.g., to 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
                                Summarytrue
                                Requirements

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

                                34. 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 refrence 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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                36. 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 alpha-numeric type name to ensure that it is computable friendly.

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

                                Support human navigation and code generation.

                                38. 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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                40. PlanDefinition.type
                                Definition

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

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

                                The type of PlanDefinition

                                TypeCodeableConcept
                                Summarytrue
                                42. 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 vs. not.
                                This is labeled as "Is Modifier" because applications should not use a retired plan definition without due consideration.

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

                                The lifecycle status of a Value Set or Concept Map.

                                Typecode
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                44. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production.

                                Control0..1
                                Typeboolean
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                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.

                                46. PlanDefinition.date
                                Definition

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

                                ShortDate this was last changed
                                Comments

                                Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

                                Control0..1
                                TypedateTime
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesRevision Date
                                48. PlanDefinition.publisher
                                Definition

                                The name of the individual or organization 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
                                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.

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

                                Control0..1
                                Typemarkdown
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                52. PlanDefinition.purpose
                                Definition

                                Explaination 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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                54. PlanDefinition.usage
                                Definition

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

                                ShortDescribes the clinical usage of the asset
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                56. 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 / editorial corrections.

                                Control0..1
                                Typedate
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                58. PlanDefinition.lastReviewDate
                                Definition

                                The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

                                ShortWhen the plan definition was last reviewed
                                Comments

                                If specified, this is usually after the approval date.

                                Control0..1
                                Typedate
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Requirements

                                Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

                                60. 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
                                Summarytrue
                                Requirements

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

                                62. PlanDefinition.useContext
                                Definition

                                The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.

                                ShortContext the content is intended to support
                                Comments

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

                                Control0..*
                                TypeUsageContext
                                Summarytrue
                                Requirements

                                Assist in searching for appropriate content.

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

                                Countries and regions within which this artifact is targeted for use

                                TypeCodeableConcept
                                Summarytrue
                                66. 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, etc
                                Control0..*
                                BindingFor example codes, see DefinitionTopic
                                (example to http://hl7.org/fhir/ValueSet/definition-topic|3.0.2)

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

                                TypeCodeableConcept
                                Requirements

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

                                68. PlanDefinition.contributor
                                Definition

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

                                ShortA content contributor
                                Control0..*
                                TypeContributor
                                Requirements

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

                                70. PlanDefinition.contributor.id
                                Definition

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

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                72. PlanDefinition.contributor.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on PlanDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 74. PlanDefinition.contributor.extension:author
                                  Slice Nameauthor
                                  Definition

                                  R5: PlanDefinition.author additional types (ContactDetail) additional types from child elements (name, telecom)

                                  ShortR5: Who authored the content additional types
                                  Comments

                                  Element PlanDefinition.author is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.author do not cover the following types: ContactDetail. The mappings for PlanDefinition.author do not cover the following types based on type expansion: name, telecom.

                                  Control0..*
                                  TypeExtension(R5: Who authored the content additional types) (Complex Extension)
                                  76. PlanDefinition.contributor.extension:editor
                                  Slice Nameeditor
                                  Definition

                                  R5: PlanDefinition.editor additional types (ContactDetail) additional types from child elements (name, telecom)

                                  ShortR5: Who edited the content additional types
                                  Comments

                                  Element PlanDefinition.editor is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.editor do not cover the following types: ContactDetail. The mappings for PlanDefinition.editor do not cover the following types based on type expansion: name, telecom.

                                  Control0..*
                                  TypeExtension(R5: Who edited the content additional types) (Complex Extension)
                                  78. PlanDefinition.contributor.extension:reviewer
                                  Slice Namereviewer
                                  Definition

                                  R5: PlanDefinition.reviewer additional types (ContactDetail) additional types from child elements (name, telecom)

                                  ShortR5: Who reviewed the content additional types
                                  Comments

                                  Element PlanDefinition.reviewer is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.reviewer do not cover the following types: ContactDetail. The mappings for PlanDefinition.reviewer do not cover the following types based on type expansion: name, telecom. See guidance around (not) making local changes to elements here.

                                  Control0..*
                                  TypeExtension(R5: Who reviewed the content additional types) (Complex Extension)
                                  80. PlanDefinition.contributor.extension:endorser
                                  Slice Nameendorser
                                  Definition

                                  R5: PlanDefinition.endorser additional types (ContactDetail) additional types from child elements (name, telecom)

                                  ShortR5: Who endorsed the content additional types
                                  Comments

                                  Element PlanDefinition.endorser is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.endorser do not cover the following types: ContactDetail. The mappings for PlanDefinition.endorser do not cover the following types based on type expansion: name, telecom. See guidance around (not) making local changes to elements here.

                                  Control0..*
                                  TypeExtension(R5: Who endorsed the content additional types) (Complex Extension)
                                  82. PlanDefinition.contributor.type
                                  Definition

                                  The type of contributor.

                                  Shortauthor | editor | reviewer | endorser
                                  Control1..1
                                  BindingThe codes SHALL be taken from ContributorType
                                  (required to http://hl7.org/fhir/ValueSet/contributor-type|3.0.2)

                                  The type of contributor

                                  Typecode
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  84. PlanDefinition.contributor.name
                                  Definition

                                  The name of the individual or organization responsible for the contribution.

                                  ShortWho contributed the content
                                  Control1..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  86. PlanDefinition.contributor.contact
                                  Definition

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

                                  ShortContact details of the contributor
                                  Control0..*
                                  TypeContactDetail
                                  Summarytrue
                                  88. 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
                                  Summarytrue
                                  90. PlanDefinition.contact.id
                                  Definition

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

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  92. PlanDefinition.contact.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on PlanDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 94. PlanDefinition.contact.extension:contact
                                    Slice Namecontact
                                    Definition

                                    R5: PlanDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

                                    ShortR5: contact additional types
                                    Comments

                                    Element PlanDefinition.contact is mapped to FHIR STU3 element PlanDefinition.contact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.contact do not cover the following types: ContactDetail. The mappings for PlanDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

                                    See guidance around (not) making local changes to elements here.

                                    Control0..*
                                    TypeExtension(R5: contact additional types) (Complex Extension)
                                    96. PlanDefinition.contact.name
                                    Definition

                                    The name of an individual to contact.

                                    ShortName of an individual to contact
                                    Comments

                                    If there is no named individual, the telecom information is for the organization as a whole.

                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    98. PlanDefinition.contact.telecom
                                    Definition

                                    The contact details for the individual (if a name was provided) or the organization.

                                    ShortContact details for individual or organization
                                    Control0..*
                                    TypeContactPoint
                                    Summarytrue
                                    100. 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
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Requirements

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

                                    Alternate NamesLicense, Restrictions
                                    102. PlanDefinition.relatedArtifact
                                    Definition

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

                                    ShortRelated artifacts for the asset
                                    Comments

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

                                    Control0..*
                                    TypeRelatedArtifact
                                    Requirements

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

                                    104. 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..*
                                    TypeReference(Library)
                                    106. PlanDefinition.library.id
                                    Definition

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

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    108. PlanDefinition.library.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    SlicingThis element introduces a set of slices on PlanDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 110. PlanDefinition.library.extension:library
                                      Slice Namelibrary
                                      Definition

                                      R5: PlanDefinition.library additional types (canonical(http://hl7.org/fhir/StructureDefinition/Library)) additional types from child elements (value)

                                      ShortR5: library additional types
                                      Comments

                                      Element PlanDefinition.library is mapped to FHIR STU3 element PlanDefinition.library as SourceIsBroaderThanTarget. The mappings for PlanDefinition.library do not cover the following types: canonical. The mappings for PlanDefinition.library do not cover the following types based on type expansion: value.

                                      Control0..*
                                      TypeExtension(R5: library additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library))
                                      112. PlanDefinition.library.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortLiteral reference, Relative, internal or absolute URL
                                      Comments

                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                      Control0..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      114. PlanDefinition.library.identifier
                                      Definition

                                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                      ShortLogical reference, when literal reference is not known
                                      Comments

                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Summarytrue
                                      116. PlanDefinition.library.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      118. 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..*
                                      TypeBackboneElement
                                      Requirements

                                      Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.

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

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

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      122. PlanDefinition.goal.extension
                                      Definition

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

                                      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
                                      Alternate Namesextensions, user content
                                      124. PlanDefinition.goal.modifierExtension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      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 No Modifier Reason provideed in previous versions of FHIR
                                      Summarytrue
                                      Alternate Namesextensions, user content, modifiers
                                      126. PlanDefinition.goal.category
                                      Definition

                                      Indicates a category the goal falls within.

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

                                      Example codes for grouping goals for filtering or presentation

                                      TypeCodeableConcept
                                      128. PlanDefinition.goal.description
                                      Definition

                                      Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

                                      ShortCode or text describing the goal
                                      Comments

                                      If no code is available, use CodeableConcept.text.

                                      Control1..1
                                      BindingFor example codes, see SNOMED CT Clinical Findings
                                      (example to http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2)

                                      Describes goals that can be achieved

                                      TypeCodeableConcept
                                      130. PlanDefinition.goal.priority
                                      Definition

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

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

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

                                      TypeCodeableConcept
                                      132. PlanDefinition.goal.start
                                      Definition

                                      The event after which the goal should begin being pursued.

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

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

                                      TypeCodeableConcept
                                      134. PlanDefinition.goal.addresses
                                      Definition

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

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

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

                                      TypeCodeableConcept
                                      136. PlanDefinition.goal.documentation
                                      Definition

                                      Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

                                      ShortSupporting documentation for the goal
                                      Control0..*
                                      TypeRelatedArtifact
                                      138. PlanDefinition.goal.target
                                      Definition

                                      Indicates what should be done and within what timeframe.

                                      ShortTarget outcome for the goal
                                      Control0..*
                                      TypeBackboneElement
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                      140. PlanDefinition.goal.target.id
                                      Definition

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

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      142. PlanDefinition.goal.target.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      SlicingThis element introduces a set of slices on PlanDefinition.goal.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 144. PlanDefinition.goal.target.extension:detail
                                        Slice Namedetail
                                        Definition

                                        R5: PlanDefinition.goal.target.detail[x] additional types (string, boolean, integer, Ratio)

                                        ShortR5: detail additional types
                                        Comments

                                        Element PlanDefinition.goal.target.detail[x] is mapped to FHIR STU3 element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: boolean, integer, Ratio, string. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(R5: detail additional types) (Extension Type: Choice of: string, boolean, integer, Ratio)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        146. PlanDefinition.goal.target.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        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 No Modifier Reason provideed in previous versions of FHIR
                                        Summarytrue
                                        Alternate Namesextensions, user content, modifiers
                                        148. PlanDefinition.goal.target.measure
                                        Definition

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

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

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

                                        TypeCodeableConcept
                                        150. PlanDefinition.goal.target.detail[x]
                                        Definition

                                        The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                                        ShortThe target value to be achieved
                                        Control0..1
                                        TypeChoice of: Quantity, Range, CodeableConcept
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        152. PlanDefinition.goal.target.due
                                        Definition

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

                                        ShortReach goal within
                                        Control0..1
                                        TypeDuration
                                        154. PlanDefinition.action
                                        Definition

                                        An action to be taken as part of the plan.

                                        ShortAction defined by the plan
                                        Control0..*
                                        TypeBackboneElement
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                        156. 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.

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        158. PlanDefinition.action.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        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
                                        • 160. PlanDefinition.action.extension:linkId
                                          Slice NamelinkId
                                          Definition

                                          R5: PlanDefinition.action.linkId (new:string)

                                          ShortR5: Unique id for the action in the PlanDefinition (new)
                                          Comments

                                          Element PlanDefinition.action.linkId has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.linkId has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R5: Unique id for the action in the PlanDefinition (new)) (Extension Type: string)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          162. PlanDefinition.action.extension:priority
                                          Slice Namepriority
                                          Definition

                                          R5: PlanDefinition.action.priority (new:code)

                                          ShortR5: routine | urgent | asap | stat (new)
                                          Comments

                                          Element PlanDefinition.action.priority has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.priority has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R5: routine | urgent | asap | stat (new)) (Extension Type: code)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          164. PlanDefinition.action.extension:subject
                                          Slice Namesubject
                                          Definition

                                          R5: PlanDefinition.action.subject[x] (new:canonical, CodeableConcept, Reference(Group))

                                          ShortR5: Type of individual the action is focused on (new)
                                          Comments

                                          Element PlanDefinition.action.subject[x] has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.subject[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R5: Type of individual the action is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group), uri)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          166. PlanDefinition.action.extension:timing
                                          Slice Nametiming
                                          Definition

                                          R5: PlanDefinition.action.timing[x] additional types (Age)

                                          ShortR5: timing additional types
                                          Comments

                                          Element PlanDefinition.action.timing[x] is mapped to FHIR STU3 element PlanDefinition.action.timing[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.timing[x] do not cover the following types: Age. The target context PlanDefinition.action.timing[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.action. The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R5: timing additional types) (Extension Type: Age)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          168. PlanDefinition.action.extension:location
                                          Slice Namelocation
                                          Definition

                                          R5: PlanDefinition.action.location (new:CodeableReference(Location))

                                          ShortR5: Where it should happen (new)
                                          Comments

                                          Element PlanDefinition.action.location has a context of PlanDefinition.action based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.location has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). May reference a specific clinical location or may just identify a type of location.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R5: Where it should happen (new)) (Complex Extension)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          170. PlanDefinition.action.modifierExtension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                          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 No Modifier Reason provideed in previous versions of FHIR
                                          Summarytrue
                                          Alternate Namesextensions, user content, modifiers
                                          172. PlanDefinition.action.label
                                          Definition

                                          A user-visible label for the action.

                                          ShortUser-visible label for the action (e.g. 1. or A.)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          174. PlanDefinition.action.title
                                          Definition

                                          The title of the action displayed to a user.

                                          ShortUser-visible title
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          176. PlanDefinition.action.description
                                          Definition

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

                                          ShortShort description of the action
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          178. PlanDefinition.action.textEquivalent
                                          Definition

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

                                          ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          180. PlanDefinition.action.code
                                          Definition

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

                                          ShortCode representing the meaning of the action or sub-actions
                                          Control0..*
                                          TypeCodeableConcept
                                          182. PlanDefinition.action.reason
                                          Definition

                                          A description of why this action is necessary or appropriate.

                                          ShortWhy the action should be performed
                                          Comments

                                          This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.

                                          Control0..*
                                          TypeCodeableConcept
                                          184. 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
                                          186. 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
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          188. PlanDefinition.action.triggerDefinition
                                          Definition

                                          A description of when the action should be triggered.

                                          ShortWhen the action should be triggered
                                          Control0..*
                                          TypeTriggerDefinition
                                          190. PlanDefinition.action.condition
                                          Definition

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

                                          ShortWhether or not the action is applicable
                                          Control0..*
                                          TypeBackboneElement
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          192. PlanDefinition.action.condition.id
                                          Definition

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

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          194. PlanDefinition.action.condition.extension
                                          Definition

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

                                          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
                                          Alternate Namesextensions, user content
                                          196. PlanDefinition.action.condition.modifierExtension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                          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 No Modifier Reason provideed in previous versions of FHIR
                                          Summarytrue
                                          Alternate Namesextensions, user content, modifiers
                                          198. PlanDefinition.action.condition.kind
                                          Definition

                                          The kind of condition.

                                          Shortapplicability | start | stop
                                          Comments

                                          Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when 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|3.0.2)

                                          Defines the kinds of conditions that can appear on actions

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          200. PlanDefinition.action.condition.description
                                          Definition

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

                                          ShortNatural language description of the condition
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          202. PlanDefinition.action.condition.language
                                          Definition

                                          The media type of the language for the expression.

                                          ShortLanguage of the expression
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          204. PlanDefinition.action.condition.expression
                                          Definition

                                          An expression that returns true or false, indicating whether or not 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
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          206. PlanDefinition.action.input
                                          Definition

                                          Defines input data requirements for the action.

                                          ShortInput data requirements
                                          Control0..*
                                          TypeDataRequirement
                                          208. PlanDefinition.action.input.id
                                          Definition

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

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          210. PlanDefinition.action.input.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 212. PlanDefinition.action.input.extension:title
                                            Slice Nametitle
                                            Definition

                                            R5: PlanDefinition.action.input.title (new:string)

                                            ShortR5: User-visible title (new)
                                            Comments

                                            Element PlanDefinition.action.input.title has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                            Control0..1
                                            TypeExtension(R5: User-visible title (new)) (Extension Type: string)
                                            214. PlanDefinition.action.input.extension:requirement
                                            Slice Namerequirement
                                            Definition

                                            R5: PlanDefinition.action.input.requirement (new:DataRequirement)

                                            ShortR5: What data is provided (new)
                                            Comments

                                            Element PlanDefinition.action.input.requirement has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.requirement has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                            Control0..1
                                            TypeExtension(R5: What data is provided (new)) (Complex Extension)
                                            216. PlanDefinition.action.input.extension:relatedData
                                            Slice NamerelatedData
                                            Definition

                                            R5: PlanDefinition.action.input.relatedData (new:id)

                                            ShortR5: What data is provided (new)
                                            Comments

                                            Element PlanDefinition.action.input.relatedData has a context of PlanDefinition.action.input based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.input.relatedData has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

                                            Control0..1
                                            TypeExtension(R5: What data is provided (new)) (Extension Type: id)
                                            218. PlanDefinition.action.input.type
                                            Definition

                                            The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

                                            ShortThe type of the required data
                                            Control1..1
                                            BindingThe codes SHALL be taken from FHIRAllTypes
                                            (required to http://hl7.org/fhir/ValueSet/all-types|3.0.2)

                                            Either an abstract type, a resource or a data type.

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            220. PlanDefinition.action.input.profile
                                            Definition

                                            The profile of the required data, specified as the uri of the profile definition.

                                            ShortThe profile of the required data
                                            Control0..*
                                            Typeuri
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            222. PlanDefinition.action.input.mustSupport
                                            Definition

                                            Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.

                                            ShortIndicates that specific structure elements are referenced by the knowledge module
                                            Control0..*
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            224. PlanDefinition.action.input.codeFilter
                                            Definition

                                            Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.

                                            ShortWhat codes are expected
                                            Control0..*
                                            TypeElement
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                            226. PlanDefinition.action.input.codeFilter.id
                                            Definition

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

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            228. PlanDefinition.action.input.codeFilter.extension
                                            Definition

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

                                            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
                                            Alternate Namesextensions, user content
                                            SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 230. PlanDefinition.action.input.codeFilter.path
                                              Definition

                                              The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

                                              ShortThe code-valued attribute of the filter
                                              Control1..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              232. PlanDefinition.action.input.codeFilter.valueSet[x]
                                              Definition

                                              The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

                                              ShortValueset for the filter
                                              Control0..1
                                              TypeChoice of: string, Reference(ValueSet)
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              234. PlanDefinition.action.input.codeFilter.valueCode
                                              Definition

                                              The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.

                                              ShortWhat code is expected
                                              Control0..*
                                              Typecode
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              236. PlanDefinition.action.input.codeFilter.valueCoding
                                              Definition

                                              The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.

                                              ShortWhat Coding is expected
                                              Control0..*
                                              TypeCoding
                                              Summarytrue
                                              238. PlanDefinition.action.input.codeFilter.valueCodeableConcept
                                              Definition

                                              The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.

                                              ShortWhat CodeableConcept is expected
                                              Control0..*
                                              TypeCodeableConcept
                                              Summarytrue
                                              240. PlanDefinition.action.input.dateFilter
                                              Definition

                                              Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.

                                              ShortWhat dates/date ranges are expected
                                              Control0..*
                                              TypeElement
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                              242. PlanDefinition.action.input.dateFilter.id
                                              Definition

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

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              244. PlanDefinition.action.input.dateFilter.extension
                                              Definition

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

                                              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
                                              Alternate Namesextensions, user content
                                              SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 246. PlanDefinition.action.input.dateFilter.path
                                                Definition

                                                The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.

                                                ShortThe date-valued attribute of the filter
                                                Control1..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                248. PlanDefinition.action.input.dateFilter.value[x]
                                                Definition

                                                The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.

                                                ShortThe value of the filter, as a Period, DateTime, or Duration value
                                                Control0..1
                                                TypeChoice of: dateTime, Period, Duration
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                250. PlanDefinition.action.output
                                                Definition

                                                Defines the outputs of the action, if any.

                                                ShortOutput data definition
                                                Control0..*
                                                TypeDataRequirement
                                                252. PlanDefinition.action.output.id
                                                Definition

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

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                254. PlanDefinition.action.output.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 256. PlanDefinition.action.output.extension:title
                                                  Slice Nametitle
                                                  Definition

                                                  R5: PlanDefinition.action.output.title (new:string)

                                                  ShortR5: User-visible title (new)
                                                  Comments

                                                  Element PlanDefinition.action.output.title has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                                  Control0..1
                                                  TypeExtension(R5: User-visible title (new)) (Extension Type: string)
                                                  258. PlanDefinition.action.output.extension:requirement
                                                  Slice Namerequirement
                                                  Definition

                                                  R5: PlanDefinition.action.output.requirement (new:DataRequirement)

                                                  ShortR5: What data is provided (new)
                                                  Comments

                                                  Element PlanDefinition.action.output.requirement has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.requirement has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                                  Control0..1
                                                  TypeExtension(R5: What data is provided (new)) (Complex Extension)
                                                  260. PlanDefinition.action.output.extension:relatedData
                                                  Slice NamerelatedData
                                                  Definition

                                                  R5: PlanDefinition.action.output.relatedData (new:string)

                                                  ShortR5: What data is provided (new)
                                                  Comments

                                                  Element PlanDefinition.action.output.relatedData has a context of PlanDefinition.action.output based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.output.relatedData has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

                                                  Control0..1
                                                  TypeExtension(R5: What data is provided (new)) (Extension Type: string)
                                                  262. PlanDefinition.action.output.type
                                                  Definition

                                                  The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

                                                  ShortThe type of the required data
                                                  Control1..1
                                                  BindingThe codes SHALL be taken from FHIRAllTypes
                                                  (required to http://hl7.org/fhir/ValueSet/all-types|3.0.2)

                                                  Either an abstract type, a resource or a data type.

                                                  Typecode
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  264. PlanDefinition.action.output.profile
                                                  Definition

                                                  The profile of the required data, specified as the uri of the profile definition.

                                                  ShortThe profile of the required data
                                                  Control0..*
                                                  Typeuri
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  266. PlanDefinition.action.output.mustSupport
                                                  Definition

                                                  Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.

                                                  ShortIndicates that specific structure elements are referenced by the knowledge module
                                                  Control0..*
                                                  Typestring
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  268. PlanDefinition.action.output.codeFilter
                                                  Definition

                                                  Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.

                                                  ShortWhat codes are expected
                                                  Control0..*
                                                  TypeElement
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                  270. PlanDefinition.action.output.codeFilter.id
                                                  Definition

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

                                                  Shortxml:id (or equivalent in JSON)
                                                  Control0..1
                                                  Typestring
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  272. PlanDefinition.action.output.codeFilter.extension
                                                  Definition

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

                                                  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
                                                  Alternate Namesextensions, user content
                                                  SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 274. PlanDefinition.action.output.codeFilter.path
                                                    Definition

                                                    The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

                                                    ShortThe code-valued attribute of the filter
                                                    Control1..1
                                                    Typestring
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    276. PlanDefinition.action.output.codeFilter.valueSet[x]
                                                    Definition

                                                    The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

                                                    ShortValueset for the filter
                                                    Control0..1
                                                    TypeChoice of: string, Reference(ValueSet)
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    278. PlanDefinition.action.output.codeFilter.valueCode
                                                    Definition

                                                    The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.

                                                    ShortWhat code is expected
                                                    Control0..*
                                                    Typecode
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    280. PlanDefinition.action.output.codeFilter.valueCoding
                                                    Definition

                                                    The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.

                                                    ShortWhat Coding is expected
                                                    Control0..*
                                                    TypeCoding
                                                    Summarytrue
                                                    282. PlanDefinition.action.output.codeFilter.valueCodeableConcept
                                                    Definition

                                                    The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.

                                                    ShortWhat CodeableConcept is expected
                                                    Control0..*
                                                    TypeCodeableConcept
                                                    Summarytrue
                                                    284. PlanDefinition.action.output.dateFilter
                                                    Definition

                                                    Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.

                                                    ShortWhat dates/date ranges are expected
                                                    Control0..*
                                                    TypeElement
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                    286. PlanDefinition.action.output.dateFilter.id
                                                    Definition

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

                                                    Shortxml:id (or equivalent in JSON)
                                                    Control0..1
                                                    Typestring
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    288. PlanDefinition.action.output.dateFilter.extension
                                                    Definition

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

                                                    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
                                                    Alternate Namesextensions, user content
                                                    SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 290. PlanDefinition.action.output.dateFilter.path
                                                      Definition

                                                      The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.

                                                      ShortThe date-valued attribute of the filter
                                                      Control1..1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      292. PlanDefinition.action.output.dateFilter.value[x]
                                                      Definition

                                                      The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.

                                                      ShortThe value of the filter, as a Period, DateTime, or Duration value
                                                      Control0..1
                                                      TypeChoice of: dateTime, Period, Duration
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      294. 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
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                      296. 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.

                                                      Shortxml:id (or equivalent in JSON)
                                                      Control0..1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      298. PlanDefinition.action.relatedAction.extension
                                                      Definition

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

                                                      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
                                                      Alternate Namesextensions, user content
                                                      300. PlanDefinition.action.relatedAction.modifierExtension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                      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 No Modifier Reason provideed in previous versions of FHIR
                                                      Summarytrue
                                                      Alternate Namesextensions, user content, modifiers
                                                      302. PlanDefinition.action.relatedAction.actionId
                                                      Definition

                                                      The element id of the related action.

                                                      ShortWhat action is this related to
                                                      Control1..1
                                                      Typeid
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      304. 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|3.0.2)

                                                      Defines the types of relationships between actions

                                                      Typecode
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      306. 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]
                                                      308. PlanDefinition.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, Period, Duration, Range, Timing
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      310. PlanDefinition.action.participant
                                                      Definition

                                                      Indicates who should participate in performing the action described.

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

                                                      Shortxml:id (or equivalent in JSON)
                                                      Control0..1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      314. PlanDefinition.action.participant.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..*
                                                      TypeExtension
                                                      SlicingThis element introduces a set of slices on PlanDefinition.action.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 316. PlanDefinition.action.participant.extension:actorId
                                                        Slice NameactorId
                                                        Definition

                                                        R5: PlanDefinition.action.participant.actorId (new:string)

                                                        ShortR5: What actor (new)
                                                        Comments

                                                        Element PlanDefinition.action.participant.actorId has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.actorId has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(R5: What actor (new)) (Extension Type: string)
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        318. PlanDefinition.action.participant.extension:typeCanonical
                                                        Slice NametypeCanonical
                                                        Definition

                                                        R5: PlanDefinition.action.participant.typeCanonical (new:canonical(CapabilityStatement))

                                                        ShortR5: Who or what can participate (new)
                                                        Comments

                                                        Element PlanDefinition.action.participant.typeCanonical has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.typeCanonical has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement))
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        320. PlanDefinition.action.participant.extension:typeReference
                                                        Slice NametypeReference
                                                        Definition

                                                        R5: PlanDefinition.action.participant.typeReference (new:Reference(CareTeam,Device,DeviceDefinition,Endpoint,Group,HealthcareService,Location,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson))

                                                        ShortR5: Who or what can participate (new)
                                                        Comments

                                                        Element PlanDefinition.action.participant.typeReference has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.typeReference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson))
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        322. PlanDefinition.action.participant.extension:function
                                                        Slice Namefunction
                                                        Definition

                                                        R5: PlanDefinition.action.participant.function (new:CodeableConcept)

                                                        ShortR5: E.g. Author, Reviewer, Witness, etc (new)
                                                        Comments

                                                        Element PlanDefinition.action.participant.function has a context of PlanDefinition.action.participant based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.action.participant.function has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(R5: E.g. Author, Reviewer, Witness, etc (new)) (Extension Type: CodeableConcept)
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        324. PlanDefinition.action.participant.modifierExtension
                                                        Definition

                                                        May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                        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 No Modifier Reason provideed in previous versions of FHIR
                                                        Summarytrue
                                                        Alternate Namesextensions, user content, modifiers
                                                        326. PlanDefinition.action.participant.type
                                                        Definition

                                                        The type of participant in the action.

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

                                                        The type of participant for the action

                                                        Typecode
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        328. PlanDefinition.action.participant.type.id
                                                        Definition

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

                                                        Shortxml:id (or equivalent in JSON)
                                                        Control0..1
                                                        Typestring
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        330. PlanDefinition.action.participant.type.extension
                                                        Definition

                                                        An Extension

                                                        ShortExtension
                                                        Control0..*
                                                        TypeExtension
                                                        SlicingThis element introduces a set of slices on PlanDefinition.action.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 332. PlanDefinition.action.participant.type.extension:type
                                                          Slice Nametype
                                                          Definition

                                                          R5: PlanDefinition.action.participant.type

                                                          ShortR5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                                                          Comments

                                                          Element PlanDefinition.action.participant.type is mapped to FHIR STU3 element PlanDefinition.action.participant.type as SourceIsBroaderThanTarget.

                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          TypeExtension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (Extension Type: code)
                                                          Is Modifierfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          334. PlanDefinition.action.participant.type.value
                                                          Definition

                                                          Primitive value for code

                                                          ShortPrimitive value for code
                                                          Control0..1
                                                          Typecode
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          336. PlanDefinition.action.participant.role
                                                          Definition

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

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

                                                          Defines roles played by participants for the action

                                                          TypeCodeableConcept
                                                          338. PlanDefinition.action.type
                                                          Definition

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

                                                          Shortcreate | update | remove | fire-event
                                                          Control0..1
                                                          BindingThe codes SHALL be taken from ActionType
                                                          (required to http://hl7.org/fhir/ValueSet/action-type|3.0.2)

                                                          The type of action to be performed

                                                          TypeCoding
                                                          340. PlanDefinition.action.type.id
                                                          Definition

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

                                                          Shortxml:id (or equivalent in JSON)
                                                          Control0..1
                                                          Typestring
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          342. PlanDefinition.action.type.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..*
                                                          TypeExtension
                                                          SlicingThis element introduces a set of slices on PlanDefinition.action.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 344. PlanDefinition.action.type.extension:type
                                                            Slice Nametype
                                                            Definition

                                                            R5: PlanDefinition.action.type additional types (CodeableConcept) additional types from child elements (text)

                                                            ShortR5: type additional types
                                                            Comments

                                                            Element PlanDefinition.action.type is mapped to FHIR STU3 element PlanDefinition.action.type as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.type do not cover the following types: CodeableConcept. The mappings for PlanDefinition.action.type do not cover the following types based on type expansion: text.

                                                            Control0..1
                                                            TypeExtension(R5: type additional types) (Extension Type: CodeableConcept)
                                                            346. PlanDefinition.action.type.system
                                                            Definition

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

                                                            ShortIdentity of the terminology system
                                                            Comments

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

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

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

                                                            348. PlanDefinition.action.type.version
                                                            Definition

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

                                                            ShortVersion of the system - if relevant
                                                            Comments

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

                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                            Control0..1
                                                            Typestring
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            350. PlanDefinition.action.type.code
                                                            Definition

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

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

                                                            Need to refer to a particular code in the system.

                                                            352. PlanDefinition.action.type.display
                                                            Definition

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

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

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

                                                            354. PlanDefinition.action.type.userSelected
                                                            Definition

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

                                                            ShortIf this coding was chosen directly by the user
                                                            Comments

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

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

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

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

                                                            Defines organization behavior of a group

                                                            Typecode
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            358. 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|3.0.2)

                                                            Defines selection behavior of a group

                                                            Typecode
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            360. PlanDefinition.action.requiredBehavior
                                                            Definition

                                                            Defines the requiredness 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|3.0.2)

                                                            Defines requiredness behavior for selecting an action or an action group

                                                            Typecode
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            362. PlanDefinition.action.precheckBehavior
                                                            Definition

                                                            Defines whether the action should usually be preselected.

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

                                                            Defines selection frequency behavior for an action or group

                                                            Typecode
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            364. PlanDefinition.action.cardinalityBehavior
                                                            Definition

                                                            Defines whether the action can be selected multiple times.

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

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

                                                            Typecode
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            366. PlanDefinition.action.definition
                                                            Definition

                                                            A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

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

                                                            Control0..1
                                                            TypeReference(ActivityDefinition, PlanDefinition)
                                                            368. PlanDefinition.action.definition.id
                                                            Definition

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

                                                            Shortxml:id (or equivalent in JSON)
                                                            Control0..1
                                                            Typestring
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            370. PlanDefinition.action.definition.extension
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..*
                                                            TypeExtension
                                                            SlicingThis element introduces a set of slices on PlanDefinition.action.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 372. PlanDefinition.action.definition.extension:definition
                                                              Slice Namedefinition
                                                              Definition

                                                              R5: PlanDefinition.action.definition[x] additional types (canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/MessageDefinition), canonical(http://hl7.org/fhir/StructureDefinition/ObservationDefinition), canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/SpecimenDefinition), uri)

                                                              ShortR5: definition additional types
                                                              Comments

                                                              Element PlanDefinition.action.definition[x] is mapped to FHIR STU3 element PlanDefinition.action.definition as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.definition[x] do not cover the following types: canonical, uri. 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
                                                              TypeExtension(R5: definition additional types) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.MessageDefinition for use in FHIR STU3, MessageDefinition, Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R5.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic))
                                                              374. PlanDefinition.action.definition.reference
                                                              Definition

                                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                              ShortLiteral reference, Relative, internal or absolute URL
                                                              Comments

                                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                              Control0..1
                                                              This element is affected by the following invariants: ref-1
                                                              Typestring
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              376. PlanDefinition.action.definition.identifier
                                                              Definition

                                                              An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                              ShortLogical reference, when literal reference is not known
                                                              Comments

                                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                              Control0..1
                                                              TypeIdentifier
                                                              Summarytrue
                                                              378. PlanDefinition.action.definition.display
                                                              Definition

                                                              Plain text narrative that identifies the resource in addition to the resource reference.

                                                              ShortText alternative for the resource
                                                              Comments

                                                              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                              Control0..1
                                                              Typestring
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              380. 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
                                                              Control0..1
                                                              TypeReference(StructureMap)
                                                              382. PlanDefinition.action.transform.id
                                                              Definition

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

                                                              Shortxml:id (or equivalent in JSON)
                                                              Control0..1
                                                              Typestring
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              384. PlanDefinition.action.transform.extension
                                                              Definition

                                                              An Extension

                                                              ShortExtension
                                                              Control0..*
                                                              TypeExtension
                                                              SlicingThis element introduces a set of slices on PlanDefinition.action.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 386. PlanDefinition.action.transform.extension:transform
                                                                Slice Nametransform
                                                                Definition

                                                                R5: PlanDefinition.action.transform additional types (canonical(http://hl7.org/fhir/StructureDefinition/StructureMap)) additional types from child elements (value)

                                                                ShortR5: transform additional types
                                                                Comments

                                                                Element PlanDefinition.action.transform is mapped to FHIR STU3 element PlanDefinition.action.transform as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.transform do not cover the following types: canonical. The mappings for PlanDefinition.action.transform do not cover the following types based on type expansion: value. 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
                                                                TypeExtension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap))
                                                                388. PlanDefinition.action.transform.reference
                                                                Definition

                                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                Comments

                                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                Control0..1
                                                                This element is affected by the following invariants: ref-1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                390. PlanDefinition.action.transform.identifier
                                                                Definition

                                                                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                ShortLogical reference, when literal reference is not known
                                                                Comments

                                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                Control0..1
                                                                TypeIdentifier
                                                                Summarytrue
                                                                392. PlanDefinition.action.transform.display
                                                                Definition

                                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                                ShortText alternative for the resource
                                                                Comments

                                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                394. 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
                                                                Control0..*
                                                                TypeBackboneElement
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                                396. PlanDefinition.action.dynamicValue.id
                                                                Definition

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

                                                                Shortxml:id (or equivalent in JSON)
                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                398. PlanDefinition.action.dynamicValue.extension
                                                                Definition

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

                                                                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
                                                                Alternate Namesextensions, user content
                                                                400. PlanDefinition.action.dynamicValue.modifierExtension
                                                                Definition

                                                                May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                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 No Modifier Reason provideed in previous versions of FHIR
                                                                Summarytrue
                                                                Alternate Namesextensions, user content, modifiers
                                                                402. PlanDefinition.action.dynamicValue.description
                                                                Definition

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

                                                                ShortNatural language description of the dynamic value
                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                404. PlanDefinition.action.dynamicValue.path
                                                                Definition

                                                                The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.

                                                                ShortThe path to the element to be set dynamically
                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                406. PlanDefinition.action.dynamicValue.language
                                                                Definition

                                                                The media type of the language for the expression.

                                                                ShortLanguage of the expression
                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                408. PlanDefinition.action.dynamicValue.expression
                                                                Definition

                                                                An expression specifying the value of the customized element.

                                                                ShortAn expression that provides the dynamic value for the customization
                                                                Comments

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

                                                                Control0..1
                                                                Typestring
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                410. 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..*
                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action