Pharmaceutical Quality - Chemistry, Manufacturing and Controls (PQ-CMC) Submissions to FDA
1.0.0-ballot - STU 1-ballot United States of America flag

Pharmaceutical Quality - Chemistry, Manufacturing and Controls (PQ-CMC) Submissions to FDA, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/FHIR-us-pq-cmc-fda/ and changes regularly. See the Directory of published versions

Resource Profile: QualitySpecification - Detailed Descriptions

Active as of 2024-04-04

Definitions for the pqcmc-quality-specification resource profile.

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

0. PlanDefinition
2. PlanDefinition.meta
4. PlanDefinition.meta.profile
Control1..1
Must Supporttrue
6. PlanDefinition.extension
Control1..?
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. PlanDefinition.extension:specificationType
    Slice NamespecificationType
    Control1..1
    TypeExtension(Specification Type) (Extension Type: CodeableConcept)
    Must Supporttrue
    10. PlanDefinition.extension:spec-additional-info
    Slice Namespec-additional-info
    Definition

    Placeholder for providing any comments that are relevant to the specification. [Source: SME Defined] Examples: replaces method ABC, using the XYZ facility.

    ShortSpecification Additional Information
    Control0..1
    TypeExtension(Additional Information) (Extension Type: markdown)
    Must Supporttrue
    12. PlanDefinition.extension:work-group
    Slice Namework-group
    Control0..1
    TypeExtension(StructureDefinition Work Group) (Extension Type: code)
    14. PlanDefinition.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Must Supporttrue
    16. PlanDefinition.version
    Definition

    The alphanumeric text assigned by the sponsor to a particular edition of a specification. [Source: SME Defined] Examples: 2.1, 13.2, ST1, 00001, 00002, companyname-001. Note: This value should be unique across all specifications for a given material, not just those with the same name

    ShortSpecification Version
    NoteThis is a business versionId, not a resource version id (see discussion)
    Control1..?
    Must Supporttrue
    18. PlanDefinition.title
    Definition

    The textual identification for the specification. [Source: SME Defined] Example: <drug name> 75 mg chewable tablets Note: This may include the name of the drug substance, product or the raw material/excipients

    ShortSpecification Title
    Control1..?
    Must Supporttrue
    20. PlanDefinition.subtitle
    Definition

    An additional textual identification for the specification [Source: SME Defined].

    ShortSpecification Subtitle
    Must Supporttrue
    22. PlanDefinition.type
    Control1..?
    Must Supporttrue
    24. PlanDefinition.type.coding
    Control2..2
    Must Supporttrue
    SlicingThis element introduces a set of slices on PlanDefinition.type.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
    • value @ $this
    • 26. PlanDefinition.type.coding:DefinitionType
      Slice NameDefinitionType
      Control1..1
      Must Supporttrue
      Pattern Value{
        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code" : "workflow-definition",
        "display" : "Workflow Definition"
      }
      28. PlanDefinition.type.coding:ApprovalStatus
      Slice NameApprovalStatus
      Control1..1
      BindingThe codes SHALL be taken from Specification Status Terminology
      (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-specification-status-terminology)
      Must Supporttrue
      30. PlanDefinition.status
      Must Supporttrue
      32. PlanDefinition.subject[x]
      Control1..?
      TypeReference(Routine Drug Product, Routine Drug Substance, Excipient Drug Substance), canonical(EvidenceVariable), CodeableConcept
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      34. PlanDefinition.date
      Definition

      The date when the sponsor assigned a date to a specific version. [Source: SME Defined] Note: This is the date a particular version of the specification was internally accepted by the submitter.

      ShortSpecification Version Date
      Control1..?
      Must Supporttrue
      36. PlanDefinition.approvalDate
      Definition

      The date on which the FDA approval status for a specification became effective. [Source: SME Defined] Note: If the application is not yet approved, then this is the date of the current submission OR the date of the complete response (CR). Note: This is not the application approval status date.

      ShortSpecification Status Date
      Must Supporttrue
      38. PlanDefinition.goal
      ShortAcceptance Criteria
      Must Supporttrue
      40. PlanDefinition.goal.description
      Definition

      The text of the acceptance criteria as provided in the specification. [Source: SME Defined] Examples: White to off-white cake; 22.5 - 27.5 mg/ml Note: This is the text as it appears in the Specification.

      ShortOriginal Text
      Must Supporttrue
      42. PlanDefinition.goal.addresses
      Control1..?
      Must Supporttrue
      44. PlanDefinition.goal.addresses.coding
      46. PlanDefinition.goal.addresses.coding.code
      Definition

      A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability. Note: The concept of 'In-Process' is subsumed by the Release code.

      ShortAcceptance Criteria Usage
      Control1..?
      BindingThe codes SHALL be taken from Test Usage Terminology
      (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-usage-terminology)
      Must Supporttrue
      48. PlanDefinition.goal.addresses.text
      ShortAccpetance Criteria Usage
      50. PlanDefinition.goal.documentation
      Must Supporttrue
      52. PlanDefinition.goal.documentation.type
      Pattern Valuecomments-on
      54. PlanDefinition.goal.documentation.display
      Definition

      A textual field to provide any additional information about the acceptance criteria. [Source: SME Defined] Example: value changed from 4% to 5% on 01/01/2010)

      ShortAcceptance Criteria Additional Information
      Control1..?
      Must Supporttrue
      56. PlanDefinition.goal.target
      ShortAcceptance Criteron
      Control1..?
      Must Supporttrue
      58. PlanDefinition.goal.target.measure
      60. PlanDefinition.goal.target.measure.text
      ShortDetailed parameter being measured if more granular than Sub-Test
      Must Supporttrue
      62. PlanDefinition.goal.target.detail[x]
      TypeChoice of: Quantity, Range, CodeableConcept, integer, boolean, string, Ratio
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 64. PlanDefinition.goal.target.detail[x]:detailQuantity
        Slice NamedetailQuantity
        Definition

        The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]

        ShortValueNumeric
        Control0..1
        TypeQuantity
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Must Supporttrue
        66. PlanDefinition.goal.target.detail[x]:detailQuantity.extension
        Control1..?
        68. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode
        Slice NameinterpretationCode
        Control1..1
        TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
        Must Supporttrue
        70. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.value[x]
        Definition

        A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

        ShortInterpretation Code
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        72. PlanDefinition.goal.target.detail[x]:detailQuantity.value
        Control1..?
        Must Supporttrue
        74. PlanDefinition.goal.target.detail[x]:detailQuantity.unit
        Control1..?
        Must Supporttrue
        76. PlanDefinition.goal.target.detail[x]:detailQuantity.code
        Control1..?
        BindingThe codes SHALL be taken from Units Of Measure Terminology
        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
        Must Supporttrue
        78. PlanDefinition.goal.target.detail[x]:detailRange
        Slice NamedetailRange
        Definition

        The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]

        ShortValueNumeric (range)
        Control0..1
        TypeRange
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Must Supporttrue
        80. PlanDefinition.goal.target.detail[x]:detailRange.low
        Control1..?
        82. PlanDefinition.goal.target.detail[x]:detailRange.low.extension
        Control1..?
        84. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow
        Slice NameinterpretationCodeLow
        Control1..1
        TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
        Must Supporttrue
        86. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.value[x]
        Definition

        A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

        ShortInterpretation Code
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        88. PlanDefinition.goal.target.detail[x]:detailRange.low.value
        Control1..?
        Must Supporttrue
        90. PlanDefinition.goal.target.detail[x]:detailRange.low.unit
        Control1..?
        Must Supporttrue
        92. PlanDefinition.goal.target.detail[x]:detailRange.low.code
        Control1..?
        BindingThe codes SHALL be taken from Units Of Measure Terminology
        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
        Must Supporttrue
        94. PlanDefinition.goal.target.detail[x]:detailRange.high
        Control1..?
        96. PlanDefinition.goal.target.detail[x]:detailRange.high.extension
        Control1..?
        98. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh
        Slice NameinterpretationCodeHigh
        Control1..1
        TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
        Must Supporttrue
        100. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.value[x]
        Definition

        A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

        ShortInterpretation Code
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        102. PlanDefinition.goal.target.detail[x]:detailRange.high.value
        Control1..?
        Must Supporttrue
        104. PlanDefinition.goal.target.detail[x]:detailRange.high.unit
        Control1..?
        Must Supporttrue
        106. PlanDefinition.goal.target.detail[x]:detailRange.high.code
        Control1..?
        BindingThe codes SHALL be taken from Units Of Measure Terminology
        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
        Must Supporttrue
        108. PlanDefinition.goal.target.detail[x]:detailCodeableConcept
        Slice NamedetailCodeableConcept
        Control0..1
        TypeCodeableConcept
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Must Supporttrue
        110. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.coding
        Definition

        A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary.

        ShortInterpretation Code
        Control1..1
        BindingThe codes SHALL be taken from Interpretation Code Terminology
        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
        Must Supporttrue
        Pattern Value{
          "system" : "http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy",
          "code" : "C48793",
          "display" : "EQ"
        }
        112. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.text
        Definition

        A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - USP <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

        ShortValue
        Control1..?
        Must Supporttrue
        114. PlanDefinition.goal.target.detail[x]:detailInteger
        Slice NamedetailInteger
        Definition

        An identification number for a member of the set of results for a test, usually the sequence order in which the test was executed. Individual tests are executed on multiple samples to give greater validity to the findings. [Source SME Defined] Examples: Prepare six aliquots from the sample. Test 8 samples. If any fall above 110%, test an additional 7 samples. Record all replicate values as stated in the method.

        ShortNumber of Replicates
        Control0..1
        Typeinteger
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        116. PlanDefinition.goal.target.due
        Control0..0
        118. PlanDefinition.action
        ShortMethod
        Control1..?
        Must Supporttrue
        Invariantscmc-link-required: Action linkId is required for alternate tests ((action.relatedAction.count() > 0) implies action.linkId.exists())
        cmc-single-or-multistage: if a test is multi-stage, the test can't have a prefix and its stages must have a name and can't be named 'Single Stage' and must be unique. If it's single stage its prefix is 'Single Stage' and its groups can't have prefixes ((( prefix.exists() implies action.prefix.empty() and prefix = 'Single Stage' ) and ( prefix.empty() implies ( (action.where( prefix.exists() and prefix != 'Single Stage' ).count() = action.count()) and action.prefix.isDistinct() ) )) = true)
        120. PlanDefinition.action.extension
        Control1..?
        SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 122. PlanDefinition.action.extension:testOrder
          Slice NametestOrder
          Definition

          Test Order: The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] [Source: SME Defined] Examples: 1, 2, 3.

          ShortTest Order
          Control1..1
          TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
          Must Supporttrue
          124. PlanDefinition.action.extension:testOrder.value[x]
          Control1..?
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          Must Supporttrue
          126. PlanDefinition.action.linkId
          Shortonly required for alternate tests
          Must Supporttrue
          128. PlanDefinition.action.prefix
          Definition

          A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

          Implememtation Note: Value at this level is 'Single Stage'

          ShortStage Name
          Must Supporttrue
          130. PlanDefinition.action.title
          Definition

          The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor

          ShortTest Name
          Control1..?
          Must Supporttrue
          132. PlanDefinition.action.description
          Definition

          Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. If there is more than one comment, include in this element. Markdown allows formating for clarity.

          ShortTest Additional Information
          Must Supporttrue
          134. PlanDefinition.action.code
          Definition

          A coded value specifying the source of the method. [Source: SME Defined] Example: Compendial

          ShortTest Method Origin
          Control1..?
          Must Supporttrue
          136. PlanDefinition.action.code.coding
          138. PlanDefinition.action.code.coding.code
          Control1..?
          BindingThe codes SHALL be taken from Test Method Origin Terminology
          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-method-origin-terminology)
          Must Supporttrue
          140. PlanDefinition.action.code.text
          Definition

          The name of the technique used to determine the nature of a characteristic. [Source: SME Defined].

          ShortAnalytical Procedure
          Control1..?
          Must Supporttrue
          142. PlanDefinition.action.reason
          Definition

          A high level grouping of quality attributes for products, substances, raw materials, excipients, intermediates and reagents. [Source: SME Defined] Examples: Assay, Biological Properties.

          ShortTest Category | Test Subcategory
          Control1..2
          Must Supporttrue
          144. PlanDefinition.action.reason.extension
          Control1..?
          146. PlanDefinition.action.reason.extension:categoryLevel
          Slice NamecategoryLevel
          Control1..1
          TypeExtension(Hierarchical Level) (Extension Type: integer)
          Must Supporttrue
          148. PlanDefinition.action.reason.coding
          BindingThe codes SHALL be taken from Test Category Terminology
          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-category-terminology)
          Must Supporttrue
          150. PlanDefinition.action.reason.coding.code
          Control1..?
          Must Supporttrue
          152. PlanDefinition.action.reason.coding.display
          Control1..?
          154. PlanDefinition.action.documentation
          Control0..1
          Must Supporttrue
          156. PlanDefinition.action.documentation.type
          Pattern Valuedocumentation
          158. PlanDefinition.action.documentation.label
          Definition

          A sponsor/applicant provided alphanumeric code that identifies the procedure. [Source: SME Defined]. Example: HP1234-2008 Note: This could also be a transferred lab method.

          ShortReference to Procedure
          Control1..?
          Must Supporttrue
          160. PlanDefinition.action.goalId
          ShortReference to Acceptance Criteria
          Must Supporttrue
          162. PlanDefinition.action.relatedAction
          Definition

          Alternate Tests are one or more test that are equivalent often using differnt method or equipment. The tests are used interchangeably and only one is used to satisfy the drug product specificaion.

          ShortAlternate Test
          Must Supporttrue
          164. PlanDefinition.action.relatedAction.targetId
          Must Supporttrue
          166. PlanDefinition.action.relatedAction.relationship
          ShortCode is concurrent
          Must Supporttrue
          Pattern Valueconcurrent
          168. PlanDefinition.action.selectionBehavior
          ShortCode is exactly-one
          Must Supporttrue
          Pattern Valueexactly-one
          170. PlanDefinition.action.action
          ShortGroups or Stages
          TypeBackboneElement
          Must Supporttrue
          172. PlanDefinition.action.action.extension
          Control1..?
          SlicingThis element introduces a set of slices on PlanDefinition.action.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 174. PlanDefinition.action.action.extension:stageOrder
            Slice NamestageOrder
            Definition

            The order of the stages in regular succession. [Source: SME Defined] Examples: 1, 2, 3.

            ShortStage Sequence Order
            Control1..1
            TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
            Must Supporttrue
            176. PlanDefinition.action.action.extension:stageOrder.value[x]
            Control1..?
            [x] NoteSee Choice of Data Types for further information about how to use [x]
            Must Supporttrue
            178. PlanDefinition.action.action.prefix
            Definition

            A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

            Implememtation Note: not requried if action.prefix is 'Single Stage'

            ShortStage Name
            Must Supporttrue
            180. PlanDefinition.action.action.title
            Definition

            Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.

            ShortTest Name (only reqired if different than above)
            Must Supporttrue
            182. PlanDefinition.action.action.description
            Definition

            Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].

            Implementation Note: If there is more than one comment, include in this element. Markdown allows formating for clarity.

            ShortTest Additional Information | Stage Additional Information
            Must Supporttrue
            184. PlanDefinition.action.action.documentation
            Must Supporttrue
            186. PlanDefinition.action.action.documentation.type
            Pattern Valuedocumentation
            188. PlanDefinition.action.action.documentation.document
            Definition

            Any visual data described andor referenced in additional informatation

            ShortTest or Stage Additional Information Visual Attachments
            Control1..?
            Must Supporttrue
            190. PlanDefinition.action.action.documentation.document.contentType
            Control1..?
            Must Supporttrue
            192. PlanDefinition.action.action.documentation.document.data
            Control1..?
            Must Supporttrue
            194. PlanDefinition.action.action.documentation.document.title
            Definition

            A format or abbreviation name that identifies a file structure. [Source: SME Defined] Used for the following: Analytical Instrument Data File Type, Impurity Analysis Graphic, Impurity Analytical Instrument Data File, Impurity Chemical Structure Data File, and Substance Structure Graphic.

            ShortDocument file name including the file extension
            Control1..?
            Must Supporttrue
            196. PlanDefinition.action.action.goalId
            ShortReference to Acceptance Criteria
            Must Supporttrue
            198. PlanDefinition.action.action.action
            ShortSub-Test
            TypeBackboneElement
            Must Supporttrue
            Invariantscmc-subtest-rrt: a subtest's prefix represents relative retention time, should it exist (prefix.exists() implies prefix.single() = 'RRT')
            200. PlanDefinition.action.action.action.extension
            Control1..?
            SlicingThis element introduces a set of slices on PlanDefinition.action.action.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 202. PlanDefinition.action.action.action.extension:testOrder
              Slice NametestOrder
              Definition

              The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] Implementation note: This is a decimaal value. Number the nested test by inheriting the value action.extension[testOrder]. For example, if the action.extension[testOrder] equals 3, then the first action.action.action.extension[testOrder] would be 3.1.

              ShortTest Order
              Control1..1
              TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
              Must Supporttrue
              204. PlanDefinition.action.action.action.extension:testOrder.value[x]
              Control1..?
              [x] NoteSee Choice of Data Types for further information about how to use [x]
              Must Supporttrue
              206. PlanDefinition.action.action.action.prefix
              Definition

              RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

              Implementation Note: This value can only be 'RRT'. It is used to desinate that RRT value(s) expressed in action.action.action.title are relative retention times.

              ShortRRT
              Must Supporttrue
              208. PlanDefinition.action.action.action.title
              Definition

              Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.

              RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

              Implementation Note: For RRT, if there is a range associated with the unidentified peak then the range can be entered instead of indivual values. E.g.: 0.4 – 0.8.

              ShortTest Name | RRT (complex testing)
              Control1..?
              Must Supporttrue
              210. PlanDefinition.action.action.action.description
              Definition

              Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. Stage Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined] If there is more than one comment, include in this element. Markdown allows formating for clarity. If both types are present, indicate type.

              ShortTest Additional Information | Stage Additional Information
              Must Supporttrue
              212. PlanDefinition.action.action.action.goalId
              ShortReference to Acceptance Criteria
              Control1..?
              Must Supporttrue

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

              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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

              ShortThe definition of a plan for a series of actions, independent of any specific patient or context
              Control0..*
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
              pld-3: goalid should reference the id of a goal definition (%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not())
              pld-4: targetId should reference the id of an action (%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not())
              2. PlanDefinition.meta
              Definition

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

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              4. PlanDefinition.meta.profile
              Definition

              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

              ShortProfiles this resource claims to conform to
              Comments

              It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

              Control10..1*
              Typecanonical(StructureDefinition)
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. PlanDefinition.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

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

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

              Control0..*
              This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
              TypeResource
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              10. PlanDefinition.extension
              Definition

              An Extension


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

              ShortExtensionAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                A classification of specification related to the kind of the entity it is referencing.

                ShortSpecification Type
                Control1..1
                TypeExtension(Specification Type) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Must Supporttrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                14. PlanDefinition.extension:spec-additional-info
                Slice Namespec-additional-info
                Definition

                Placeholder for providing any comments that are relevant to the specification. [Source: SME Defined] Examples: replaces method ABC, using the XYZ facility.

                ShortSpecification Additional Information
                Control0..1
                TypeExtension(Additional Information) (Extension Type: markdown)
                Is Modifierfalse
                Must Supporttrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                16. PlanDefinition.extension:work-group
                Slice Namework-group
                Definition

                The work group that owns and maintains this resource.

                ShortOwning Work Group
                Comments

                This is mostly used in the main specification.

                Control0..1
                TypeExtension(StructureDefinition Work Group) (Extension Type: code)
                Is Modifierfalse
                Must Supportfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. PlanDefinition.modifierExtension
                Definition

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

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

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

                ShortAdditional identifier for the plan definition
                Comments

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

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

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

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

                The alphanumeric text assigned by the sponsor to a particular edition of a specification. [Source: SME Defined] Examples: 2.1, 13.2, ST1, 00001, 00002, companyname-001. Note: This value should be unique across all specifications for a given material, not just those with the same name


                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.

                ShortSpecification VersionBusiness version of the plan definition
                Comments

                There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

                NoteThis is a business versionId, not a resource version id (see discussion)
                Control10..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. PlanDefinition.title
                Definition

                The textual identification for the specification. [Source: SME Defined] Example: <drug name> 75 mg chewable tablets Note: This may include the name of the drug substance, product or the raw material/excipients


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

                ShortSpecification TitleName for this plan definition (human friendly)
                Comments

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

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

                An additional textual identification for the specification [Source: SME Defined].


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

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

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

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

                The type of PlanDefinition.

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. PlanDefinition.type.coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

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

                Control20..2*
                TypeCoding
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on PlanDefinition.type.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                • value @ $this
                • 32. PlanDefinition.type.coding:DefinitionType
                  Slice NameDefinitionType
                  Definition

                  A reference to a code defined by a terminology system.

                  ShortCode defined by a terminology system
                  Comments

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

                  Control10..1*
                  TypeCoding
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

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

                  Pattern Value{
                    "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
                    "code" : "workflow-definition",
                    "display" : "Workflow Definition"
                  }
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  34. PlanDefinition.type.coding:ApprovalStatus
                  Slice NameApprovalStatus
                  Definition

                  A reference to a code defined by a terminology system.

                  ShortCode defined by a terminology system
                  Comments

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

                  Control10..1*
                  BindingThe codes SHALL be taken from For codes, see Specification Status Terminology
                  (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-specification-status-terminology)
                  TypeCoding
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

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

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

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

                  Shortdraft | active | retired | unknown
                  Comments

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

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

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

                  The lifecycle status of an artifact.

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

                  A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

                  ShortType of individual the plan definition is focused on
                  Comments

                  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.

                  Control10..1
                  TypeReference(Routine Drug Product, Routine Drug Substance, Excipient Drug Substance, Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable), CodeableConcept
                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summaryfalse
                  Meaning if MissingPatient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  40. PlanDefinition.date
                  Definition

                  The date when the sponsor assigned a date to a specific version. [Source: SME Defined] Note: This is the date a particular version of the specification was internally accepted by the submitter.


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

                  ShortSpecification Version DateDate last changed
                  Comments

                  The date is often not tracked until the resource is published, but may be present on draft content. 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.

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

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

                  The date on which the FDA approval status for a specification became effective. [Source: SME Defined] Note: If the application is not yet approved, then this is the date of the current submission OR the date of the complete response (CR). Note: This is not the application approval status date.


                  The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

                  ShortSpecification Status DateWhen the plan definition was approved by publisher
                  Comments

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

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

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

                  A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, etc.

                  ShortAcceptance CriteriaWhat the plan is trying to accomplish
                  Control0..*
                  This element is affected by the following invariants: pld-3
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Requirements

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

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

                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                  The text of the acceptance criteria as provided in the specification. [Source: SME Defined] Examples: White to off-white cake; 22.5 - 27.5 mg/ml Note: This is the text as it appears in the Specification.


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

                  ShortOriginal TextCode or text describing the goal
                  Comments

                  If no code is available, use CodeableConcept.text.

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

                  Describes goals that can be achieved.

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

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

                  ShortWhat does the goal address
                  Control10..*
                  BindingFor example codes, see ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code
                  (example to http://hl7.org/fhir/ValueSet/condition-code)

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

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

                  A reference to a code defined by a terminology system.

                  ShortCode defined by a terminology system
                  Comments

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

                  Control0..*
                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Requirements

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

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

                  A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability. Note: The concept of 'In-Process' is subsumed by the Release code.


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

                  ShortAcceptance Criteria UsageSymbol in syntax defined by the system
                  Control10..1
                  This element is affected by the following invariants: cod-1
                  BindingThe codes SHALL be taken from For codes, see Test Usage Terminology
                  (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-usage-terminology)
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Need to refer to a particular code in the system.

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

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

                  ShortAccpetance Criteria UsagePlain text representation of the concept
                  Comments

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

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

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

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

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

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

                  The type of relationship to the related artifact.

                  Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                  Comments

                  The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                  Control1..1
                  BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
                  (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                  The type of relationship to the related artifact.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Pattern Valuecomments-on
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. PlanDefinition.goal.documentation.display
                  Definition

                  A textual field to provide any additional information about the acceptance criteria. [Source: SME Defined] Example: value changed from 4% to 5% on 01/01/2010)


                  A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

                  ShortAcceptance Criteria Additional InformationBrief description of the related artifact
                  Control10..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. PlanDefinition.goal.target
                  Definition

                  Indicates what should be done and within what timeframe.

                  ShortAcceptance CriteronTarget outcome for the goal
                  Control10..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. PlanDefinition.goal.target.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

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

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

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. PlanDefinition.goal.target.measure.text
                  Definition

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

                  ShortDetailed parameter being measured if more granular than Sub-TestPlain text representation of the concept
                  Comments

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

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

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. 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%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                  ShortThe target value to be achieved
                  Comments

                  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
                  TypeChoice of: Quantity, Range, CodeableConcept, integer, boolean, string, Ratio
                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                  • type @ $this
                  • 74. PlanDefinition.goal.target.detail[x]:detailQuantity
                    Slice NamedetailQuantity
                    Definition

                    The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]


                    The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                    ShortValueNumericThe target value to be achieved
                    Comments

                    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
                    TypeQuantity, boolean, string, Ratio, integer, Range, CodeableConcept
                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. PlanDefinition.goal.target.detail[x]:detailQuantity.extension
                    Definition

                    An Extension


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

                    ShortExtensionAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control10..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 78. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode
                      Slice NameinterpretationCode
                      Definition

                      A code that describes how to relate the given value to an acceptance value.

                      ShortInterpretation Code
                      Control1..1
                      TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      80. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.extension
                      Definition

                      An Extension


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

                      ShortExtensionAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Source of the definition for the extension code - a logical name or a URL.

                        Shortidentifies the meaning of the extension
                        Comments

                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                        84. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.value[x]
                        Definition

                        A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.


                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortInterpretation CodeValue of extension
                        Control0..1
                        This element is affected by the following invariants: ext-1
                        BindingThe codes SHALL be taken from For codes, see Interpretation Code Terminology
                        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        86. PlanDefinition.goal.target.detail[x]:detailQuantity.value
                        Definition

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

                        ShortNumerical value (with implicit precision)
                        Comments

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

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

                        Precision is handled implicitly in almost all cases of measurement.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        88. PlanDefinition.goal.target.detail[x]:detailQuantity.comparator
                        Definition

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

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

                        How the Quantity should be understood and represented.

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

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

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

                        A human-readable form of the unit.

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

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

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        92. PlanDefinition.goal.target.detail[x]:detailQuantity.code
                        Definition

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

                        ShortCoded form of the unit
                        Comments

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

                        Control10..1
                        This element is affected by the following invariants: qty-3
                        BindingThe codes SHALL be taken from For codes, see Units Of Measure Terminology
                        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

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

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        94. PlanDefinition.goal.target.detail[x]:detailRange
                        Slice NamedetailRange
                        Definition

                        The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]


                        The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                        ShortValueNumeric (range)The target value to be achieved
                        Comments

                        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
                        TypeRange, boolean, string, Quantity, Ratio, integer, CodeableConcept
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        96. PlanDefinition.goal.target.detail[x]:detailRange.low
                        Definition

                        The low limit. The boundary is inclusive.

                        ShortLow limit
                        Comments

                        If the low element is missing, the low boundary is not known.

                        Control10..1
                        This element is affected by the following invariants: rng-2
                        TypeQuantity(SimpleQuantity)
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        98. PlanDefinition.goal.target.detail[x]:detailRange.low.extension
                        Definition

                        An Extension


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

                        ShortExtensionAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control10..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].low.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 100. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow
                          Slice NameinterpretationCodeLow
                          Definition

                          A code that describes how to relate the given value to an acceptance value.

                          ShortInterpretation Code
                          Control1..1
                          TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          102. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.extension
                          Definition

                          An Extension


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

                          ShortExtensionAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                            106. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.value[x]
                            Definition

                            A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.


                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortInterpretation CodeValue of extension
                            Control0..1
                            This element is affected by the following invariants: ext-1
                            BindingThe codes SHALL be taken from For codes, see Interpretation Code Terminology
                            (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                            [x] NoteSee Choice of Data Types for further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            108. PlanDefinition.goal.target.detail[x]:detailRange.low.value
                            Definition

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

                            ShortNumerical value (with implicit precision)
                            Comments

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

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

                            Precision is handled implicitly in almost all cases of measurement.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            110. PlanDefinition.goal.target.detail[x]:detailRange.low.comparator
                            Definition

                            Not allowed to be used in this context


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

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

                            How the Quantity should be understood and represented.

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

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

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

                            A human-readable form of the unit.

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

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

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            114. PlanDefinition.goal.target.detail[x]:detailRange.low.code
                            Definition

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

                            ShortCoded form of the unit
                            Comments

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

                            Control10..1
                            This element is affected by the following invariants: qty-3
                            BindingThe codes SHALL be taken from For codes, see Units Of Measure Terminology
                            (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

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

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            116. PlanDefinition.goal.target.detail[x]:detailRange.high
                            Definition

                            The high limit. The boundary is inclusive.

                            ShortHigh limit
                            Comments

                            If the high element is missing, the high boundary is not known.

                            Control10..1
                            This element is affected by the following invariants: rng-2
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            118. PlanDefinition.goal.target.detail[x]:detailRange.high.extension
                            Definition

                            An Extension


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

                            ShortExtensionAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control10..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].high.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 120. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh
                              Slice NameinterpretationCodeHigh
                              Definition

                              A code that describes how to relate the given value to an acceptance value.

                              ShortInterpretation Code
                              Control1..1
                              TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              122. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.extension
                              Definition

                              An Extension


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

                              ShortExtensionAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                Source of the definition for the extension code - a logical name or a URL.

                                Shortidentifies the meaning of the extension
                                Comments

                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                                126. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.value[x]
                                Definition

                                A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.


                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                ShortInterpretation CodeValue of extension
                                Control0..1
                                This element is affected by the following invariants: ext-1
                                BindingThe codes SHALL be taken from For codes, see Interpretation Code Terminology
                                (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                128. PlanDefinition.goal.target.detail[x]:detailRange.high.value
                                Definition

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

                                ShortNumerical value (with implicit precision)
                                Comments

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

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

                                Precision is handled implicitly in almost all cases of measurement.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                130. PlanDefinition.goal.target.detail[x]:detailRange.high.comparator
                                Definition

                                Not allowed to be used in this context


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

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

                                How the Quantity should be understood and represented.

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

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

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

                                A human-readable form of the unit.

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

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                134. PlanDefinition.goal.target.detail[x]:detailRange.high.code
                                Definition

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

                                ShortCoded form of the unit
                                Comments

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

                                Control10..1
                                This element is affected by the following invariants: qty-3
                                BindingThe codes SHALL be taken from For codes, see Units Of Measure Terminology
                                (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Requirements

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                136. PlanDefinition.goal.target.detail[x]:detailCodeableConcept
                                Slice NamedetailCodeableConcept
                                Definition

                                The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                                ShortThe target value to be achieved
                                Comments

                                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
                                TypeCodeableConcept, boolean, string, Quantity, Ratio, integer, Range
                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                138. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.coding
                                Definition

                                A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary.


                                A reference to a code defined by a terminology system.

                                ShortInterpretation CodeCode defined by a terminology system
                                Comments

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

                                Control10..1*
                                BindingThe codes SHALL be taken from For codes, see Interpretation Code Terminology
                                (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                TypeCoding
                                Is Modifierfalse
                                Must Supporttrue
                                Summarytrue
                                Requirements

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

                                Pattern Value{
                                  "system" : "http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy",
                                  "code" : "C48793",
                                  "display" : "EQ"
                                }
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                140. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.text
                                Definition

                                A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - USP <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)


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

                                ShortValuePlain text representation of the concept
                                Comments

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

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

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                142. PlanDefinition.goal.target.detail[x]:detailInteger
                                Slice NamedetailInteger
                                Definition

                                An identification number for a member of the set of results for a test, usually the sequence order in which the test was executed. Individual tests are executed on multiple samples to give greater validity to the findings. [Source SME Defined] Examples: Prepare six aliquots from the sample. Test 8 samples. If any fall above 110%, test an additional 7 samples. Record all replicate values as stated in the method.


                                The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                                ShortNumber of ReplicatesThe target value to be achieved
                                Comments

                                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
                                Typeinteger, boolean, string, Quantity, Ratio, Range, CodeableConcept
                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                144. 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..01
                                TypeDuration
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                146. PlanDefinition.action
                                Definition

                                An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

                                ShortMethodAction defined by the plan
                                Comments

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

                                Control10..*
                                This element is affected by the following invariants: pld-3, pld-4
                                TypeBackboneElement
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                cmc-link-required: Action linkId is required for alternate tests ((action.relatedAction.count() > 0) implies action.linkId.exists())
                                cmc-single-or-multistage: if a test is multi-stage, the test can't have a prefix and its stages must have a name and can't be named 'Single Stage' and must be unique. If it's single stage its prefix is 'Single Stage' and its groups can't have prefixes ((( prefix.exists() implies action.prefix.empty() and prefix = 'Single Stage' ) and ( prefix.empty() implies ( (action.where( prefix.exists() and prefix != 'Single Stage' ).count() = action.count()) and action.prefix.isDistinct() ) )) = true)
                                148. PlanDefinition.action.extension
                                Definition

                                An Extension


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

                                ShortExtensionAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                  Test Order: The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] [Source: SME Defined] Examples: 1, 2, 3.

                                  ShortTest Order
                                  Control1..1
                                  TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  152. PlanDefinition.action.extension:testOrder.extension
                                  Definition

                                  An Extension


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

                                  ShortExtensionAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                    Source of the definition for the extension code - a logical name or a URL.

                                    Shortidentifies the meaning of the extension
                                    Comments

                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                    156. PlanDefinition.action.extension:testOrder.value[x]
                                    Definition

                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                    ShortValue of extension
                                    Control10..1
                                    This element is affected by the following invariants: ext-1
                                    Typedecimal, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                    158. PlanDefinition.action.modifierExtension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                    ShortExtensions that cannot be ignored even if unrecognized
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                    An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

                                    Shortonly required for alternate testsUnique id for the action in the PlanDefinition
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    162. PlanDefinition.action.prefix
                                    Definition

                                    A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

                                    Implememtation Note: Value at this level is 'Single Stage'


                                    A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

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

                                    The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor


                                    The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

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

                                    Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. If there is more than one comment, include in this element. Markdown allows formating for clarity.


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

                                    ShortTest Additional InformationBrief description of the action
                                    Control0..1
                                    Typemarkdown
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    168. PlanDefinition.action.code
                                    Definition

                                    A coded value specifying the source of the method. [Source: SME Defined] Example: Compendial


                                    A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

                                    ShortTest Method OriginCode representing the meaning of the action or sub-actions
                                    Control10..1
                                    BindingFor example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code
                                    (example to http://hl7.org/fhir/ValueSet/action-code)

                                    Provides examples of actions to be performed.

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

                                    A reference to a code defined by a terminology system.

                                    ShortCode defined by a terminology system
                                    Comments

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

                                    Control0..*
                                    TypeCoding
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

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

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

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

                                    ShortSymbol in syntax defined by the system
                                    Control10..1
                                    This element is affected by the following invariants: cod-1
                                    BindingThe codes SHALL be taken from For codes, see Test Method Origin Terminology
                                    (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-method-origin-terminology)
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Need to refer to a particular code in the system.

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

                                    The name of the technique used to determine the nature of a characteristic. [Source: SME Defined].


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

                                    ShortAnalytical ProcedurePlain text representation of the concept
                                    Comments

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

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

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

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

                                    A high level grouping of quality attributes for products, substances, raw materials, excipients, intermediates and reagents. [Source: SME Defined] Examples: Assay, Biological Properties.


                                    A description of why this action is necessary or appropriate.

                                    ShortTest Category | Test SubcategoryWhy 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.

                                    Control10..2*
                                    BindingFor example codes, see ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code
                                    (example to http://hl7.org/fhir/ValueSet/action-reason-code)

                                    Provides examples of reasons for actions to be performed.

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

                                    An Extension


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

                                    ShortExtensionAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                      Numeric level in the hierarchical value-set

                                      ShortHierarchical Level
                                      Control1..1
                                      TypeExtension(Hierarchical Level) (Extension Type: integer)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      182. PlanDefinition.action.reason.coding
                                      Definition

                                      A reference to a code defined by a terminology system.

                                      ShortCode defined by a terminology system
                                      Comments

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

                                      Control0..*
                                      BindingThe codes SHALL be taken from For codes, see Test Category Terminology
                                      (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-category-terminology)
                                      TypeCoding
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

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

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

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

                                      ShortSymbol in syntax defined by the system
                                      Control10..1
                                      This element is affected by the following invariants: cod-1
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to refer to a particular code in the system.

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

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

                                      ShortRepresentation defined by the system
                                      Control10..1
                                      This element is affected by the following invariants: cod-1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

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

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      188. 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..1*
                                      TypeRelatedArtifact
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      190. PlanDefinition.action.documentation.type
                                      Definition

                                      The type of relationship to the related artifact.

                                      Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                                      Comments

                                      The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                                      Control1..1
                                      BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
                                      (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                                      The type of relationship to the related artifact.

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

                                      A sponsor/applicant provided alphanumeric code that identifies the procedure. [Source: SME Defined]. Example: HP1234-2008 Note: This could also be a transferred lab method.


                                      A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

                                      ShortReference to ProcedureShort label
                                      Control10..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      194. PlanDefinition.action.goalId
                                      Definition

                                      Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                      ShortReference to Acceptance CriteriaWhat goals this action supports
                                      Control0..*
                                      This element is affected by the following invariants: pld-3
                                      Typeid
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      196. PlanDefinition.action.relatedAction
                                      Definition

                                      Alternate Tests are one or more test that are equivalent often using differnt method or equipment. The tests are used interchangeably and only one is used to satisfy the drug product specificaion.


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

                                      ShortAlternate TestRelationship 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..*
                                      This element is affected by the following invariants: pld-4
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      198. PlanDefinition.action.relatedAction.modifierExtension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                      The element id of the target related action.

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

                                      The relationship of the start of this action to the related action.

                                      ShortCode is concurrentbefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
                                      Control1..1
                                      BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
                                      (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0)

                                      Defines the types of relationships between actions.

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

                                      Defines the selection behavior for the action and its children.

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

                                      Defines selection behavior of a group.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summaryfalse
                                      Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
                                      Pattern Valueexactly-one
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      206. PlanDefinition.action.action
                                      Definition

                                      Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

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

                                      An Extension


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

                                      ShortExtensionAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                        The order of the stages in regular succession. [Source: SME Defined] Examples: 1, 2, 3.

                                        ShortStage Sequence Order
                                        Control1..1
                                        TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        212. PlanDefinition.action.action.extension:stageOrder.extension
                                        Definition

                                        An Extension


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

                                        ShortExtensionAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                          Source of the definition for the extension code - a logical name or a URL.

                                          Shortidentifies the meaning of the extension
                                          Comments

                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                          Control1..1
                                          Typeuri
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                          216. PlanDefinition.action.action.extension:stageOrder.value[x]
                                          Definition

                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                          ShortValue of extension
                                          Control10..1
                                          This element is affected by the following invariants: ext-1
                                          Typedecimal, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                          218. PlanDefinition.action.action.modifierExtension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                          ShortExtensions that cannot be ignored even if unrecognized
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                          A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

                                          Implememtation Note: not requried if action.prefix is 'Single Stage'


                                          A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

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

                                          Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.


                                          The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

                                          ShortTest Name (only reqired if different than above)User-visible title
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          224. PlanDefinition.action.action.description
                                          Definition

                                          Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].

                                          Implementation Note: If there is more than one comment, include in this element. Markdown allows formating for clarity.


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

                                          ShortTest Additional Information | Stage Additional InformationBrief description of the action
                                          Control0..1
                                          Typemarkdown
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          226. PlanDefinition.action.action.documentation
                                          Definition

                                          Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

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

                                          The type of relationship to the related artifact.

                                          Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                                          Comments

                                          The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                                          Control1..1
                                          BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
                                          (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                                          The type of relationship to the related artifact.

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

                                          Any visual data described andor referenced in additional informatation


                                          The document being referenced, represented as an attachment. This is exclusive with the resource element.

                                          ShortTest or Stage Additional Information Visual AttachmentsWhat document is being referenced
                                          Control10..1
                                          TypeAttachment
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          232. PlanDefinition.action.action.documentation.document.contentType
                                          Definition

                                          Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                          ShortMime type of the content, with charset etc.
                                          Control10..1
                                          This element is affected by the following invariants: att-1
                                          BindingThe codes SHALL be taken from MimeTypeshttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0
                                          (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)

                                          BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Processors of the data need to be able to know how to interpret the data.

                                          Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          234. PlanDefinition.action.action.documentation.document.data
                                          Definition

                                          The actual data of the attachment - a sequence of bytes, base64 encoded.

                                          ShortData inline, base64ed
                                          Comments

                                          The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

                                          Control10..1
                                          This element is affected by the following invariants: att-1
                                          Typebase64Binary
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summaryfalse
                                          Requirements

                                          The data needs to able to be transmitted inline.

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

                                          A format or abbreviation name that identifies a file structure. [Source: SME Defined] Used for the following: Analytical Instrument Data File Type, Impurity Analysis Graphic, Impurity Analytical Instrument Data File, Impurity Chemical Structure Data File, and Substance Structure Graphic.


                                          A label or set of text to display in place of the data.

                                          ShortDocument file name including the file extensionLabel to display in place of the data
                                          Comments

                                          May sometimes be derived from the source filename.

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

                                          Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                          Example<br/><b>General</b>:Official Corporate Logo
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          238. PlanDefinition.action.action.goalId
                                          Definition

                                          Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                          ShortReference to Acceptance CriteriaWhat goals this action supports
                                          Control0..*
                                          This element is affected by the following invariants: pld-3
                                          Typeid
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          240. PlanDefinition.action.action.action
                                          Definition

                                          Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

                                          ShortSub-TestA sub-action
                                          Control0..*
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          cmc-subtest-rrt: a subtest's prefix represents relative retention time, should it exist (prefix.exists() implies prefix.single() = 'RRT')
                                          242. PlanDefinition.action.action.action.extension
                                          Definition

                                          An Extension


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

                                          ShortExtensionAdditional content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                            The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] Implementation note: This is a decimaal value. Number the nested test by inheriting the value action.extension[testOrder]. For example, if the action.extension[testOrder] equals 3, then the first action.action.action.extension[testOrder] would be 3.1.

                                            ShortTest Order
                                            Control1..1
                                            TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            246. PlanDefinition.action.action.action.extension:testOrder.extension
                                            Definition

                                            An Extension


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

                                            ShortExtensionAdditional content defined by implementations
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                              Source of the definition for the extension code - a logical name or a URL.

                                              Shortidentifies the meaning of the extension
                                              Comments

                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                              250. PlanDefinition.action.action.action.extension:testOrder.value[x]
                                              Definition

                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                              ShortValue of extension
                                              Control10..1
                                              This element is affected by the following invariants: ext-1
                                              Typedecimal, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                              252. PlanDefinition.action.action.action.modifierExtension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                              ShortExtensions that cannot be ignored even if unrecognized
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                              RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

                                              Implementation Note: This value can only be 'RRT'. It is used to desinate that RRT value(s) expressed in action.action.action.title are relative retention times.


                                              A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

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

                                              Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.

                                              RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

                                              Implementation Note: For RRT, if there is a range associated with the unidentified peak then the range can be entered instead of indivual values. E.g.: 0.4 – 0.8.


                                              The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

                                              ShortTest Name | RRT (complex testing)User-visible title
                                              Control10..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              258. PlanDefinition.action.action.action.description
                                              Definition

                                              Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. Stage Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined] If there is more than one comment, include in this element. Markdown allows formating for clarity. If both types are present, indicate type.


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

                                              ShortTest Additional Information | Stage Additional InformationBrief description of the action
                                              Control0..1
                                              Typemarkdown
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              260. PlanDefinition.action.action.action.goalId
                                              Definition

                                              Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                              ShortReference to Acceptance CriteriaWhat goals this action supports
                                              Control10..*
                                              This element is affected by the following invariants: pld-3
                                              Typeid
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                              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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

                                              ShortThe definition of a plan for a series of actions, independent of any specific patient or context
                                              Control0..*
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
                                              pld-3: goalid should reference the id of a goal definition (%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not())
                                              pld-4: targetId should reference the id of an action (%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not())
                                              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

                                              Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

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

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

                                              ShortMetadata about the resource
                                              Control0..1
                                              TypeMeta
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              6. PlanDefinition.meta.id
                                              Definition

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

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              8. PlanDefinition.meta.extension
                                              Definition

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

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                                ShortVersion specific identifier
                                                Comments

                                                The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

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

                                                When the resource last changed - e.g. when the version changed.

                                                ShortWhen the resource version last changed
                                                Comments

                                                This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

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

                                                A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                                ShortIdentifies where the resource comes from
                                                Comments

                                                The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

                                                This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

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

                                                A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                                ShortProfiles this resource claims to conform to
                                                Comments

                                                It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                                                Control1..1
                                                Typecanonical(StructureDefinition)
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                18. PlanDefinition.meta.security
                                                Definition

                                                Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                                ShortSecurity Labels applied to this resource
                                                Comments

                                                The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                Control0..*
                                                BindingUnless not suitable, these codes SHALL be taken from AllSecurityLabels
                                                (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                                                Security Labels from the Healthcare Privacy and Security Classification System.

                                                TypeCoding
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                20. PlanDefinition.meta.tag
                                                Definition

                                                Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                                                ShortTags applied to this resource
                                                Comments

                                                The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                Control0..*
                                                BindingFor example codes, see CommonTags
                                                (example to http://hl7.org/fhir/ValueSet/common-tags)

                                                Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

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

                                                A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                ShortA set of rules under which this content was created
                                                Comments

                                                Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

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

                                                The base language in which the resource is written.

                                                ShortLanguage of the resource content
                                                Comments

                                                Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                                Control0..1
                                                BindingThe codes SHALL be taken from AllLanguages
                                                (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                                IETF language tag for a human language

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

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

                                                ShortText summary of the resource, for human interpretation
                                                Comments

                                                Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                                Control0..1
                                                This element is affected by the following invariants: dom-6
                                                TypeNarrative
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate Namesnarrative, html, xhtml, display
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                28. PlanDefinition.contained
                                                Definition

                                                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                                                ShortContained, inline Resources
                                                Comments

                                                This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

                                                Control0..*
                                                This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                                                TypeResource
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate Namesinline resources, anonymous resources, contained resources
                                                30. PlanDefinition.extension
                                                Definition

                                                An Extension

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

                                                  A classification of specification related to the kind of the entity it is referencing.

                                                  ShortSpecification Type
                                                  Control1..1
                                                  TypeExtension(Specification Type) (Extension Type: CodeableConcept)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  34. PlanDefinition.extension:spec-additional-info
                                                  Slice Namespec-additional-info
                                                  Definition

                                                  Placeholder for providing any comments that are relevant to the specification. [Source: SME Defined] Examples: replaces method ABC, using the XYZ facility.

                                                  ShortSpecification Additional Information
                                                  Control0..1
                                                  TypeExtension(Additional Information) (Extension Type: markdown)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  36. PlanDefinition.extension:work-group
                                                  Slice Namework-group
                                                  Definition

                                                  The work group that owns and maintains this resource.

                                                  ShortOwning Work Group
                                                  Comments

                                                  This is mostly used in the main specification.

                                                  Control0..1
                                                  TypeExtension(StructureDefinition Work Group) (Extension Type: code)
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  38. PlanDefinition.modifierExtension
                                                  Definition

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

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

                                                  ShortExtensions that cannot be ignored
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                  An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

                                                  ShortCanonical identifier for this plan definition, represented as a URI (globally unique)
                                                  Comments

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

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

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

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

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

                                                  Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  42. PlanDefinition.identifier
                                                  Definition

                                                  A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

                                                  ShortAdditional identifier for the plan definition
                                                  Comments

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

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

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

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

                                                  The alphanumeric text assigned by the sponsor to a particular edition of a specification. [Source: SME Defined] Examples: 2.1, 13.2, ST1, 00001, 00002, companyname-001. Note: This value should be unique across all specifications for a given material, not just those with the same name

                                                  ShortSpecification Version
                                                  Comments

                                                  There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

                                                  NoteThis is a business versionId, not a resource version id (see discussion)
                                                  Control1..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  46. PlanDefinition.versionAlgorithm[x]
                                                  Definition

                                                  Indicates the mechanism used to compare versions to determine which is more current.

                                                  ShortHow to compare versions
                                                  Comments

                                                  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
                                                  BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                                                  (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
                                                  TypeChoice of: string, Coding
                                                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supportfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  48. PlanDefinition.name
                                                  Definition

                                                  A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

                                                  ShortName for this plan definition (computer friendly)
                                                  Comments

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

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

                                                  Support human navigation and code generation.

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

                                                  The textual identification for the specification. [Source: SME Defined] Example: <drug name> 75 mg chewable tablets Note: This may include the name of the drug substance, product or the raw material/excipients

                                                  ShortSpecification Title
                                                  Comments

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

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

                                                  An additional textual identification for the specification [Source: SME Defined].

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

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

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

                                                  The type of PlanDefinition.

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

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  58. PlanDefinition.type.extension
                                                  Definition

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

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                    A reference to a code defined by a terminology system.

                                                    ShortCode defined by a terminology system
                                                    Comments

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

                                                    Control2..2
                                                    TypeCoding
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Requirements

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

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    SlicingThis element introduces a set of slices on PlanDefinition.type.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                                                    • value @ $this
                                                    • 62. PlanDefinition.type.coding:DefinitionType
                                                      Slice NameDefinitionType
                                                      Definition

                                                      A reference to a code defined by a terminology system.

                                                      ShortCode defined by a terminology system
                                                      Comments

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

                                                      Control1..1
                                                      TypeCoding
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

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

                                                      Pattern Value{
                                                        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
                                                        "code" : "workflow-definition",
                                                        "display" : "Workflow Definition"
                                                      }
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      64. PlanDefinition.type.coding:ApprovalStatus
                                                      Slice NameApprovalStatus
                                                      Definition

                                                      A reference to a code defined by a terminology system.

                                                      ShortCode defined by a terminology system
                                                      Comments

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

                                                      Control1..1
                                                      BindingThe codes SHALL be taken from Specification Status Terminology
                                                      (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-specification-status-terminology)
                                                      TypeCoding
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

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

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

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

                                                      ShortPlain text representation of the concept
                                                      Comments

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

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

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

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

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

                                                      Shortdraft | active | retired | unknown
                                                      Comments

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

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

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

                                                      The lifecycle status of an artifact.

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

                                                      A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

                                                      ShortFor testing purposes, not real usage
                                                      Comments

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

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

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

                                                      Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      72. PlanDefinition.subject[x]
                                                      Definition

                                                      A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

                                                      ShortType of individual the plan definition is focused on
                                                      Comments

                                                      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.

                                                      Control1..1
                                                      TypeReference(Routine Drug Product, Routine Drug Substance, Excipient Drug Substance)
                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Must Support TypesNo must-support rules about the choice of types/profiles
                                                      Summaryfalse
                                                      Meaning if MissingPatient
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      74. PlanDefinition.date
                                                      Definition

                                                      The date when the sponsor assigned a date to a specific version. [Source: SME Defined] Note: This is the date a particular version of the specification was internally accepted by the submitter.

                                                      ShortSpecification Version Date
                                                      Comments

                                                      The date is often not tracked until the resource is published, but may be present on draft content. 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.

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

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

                                                      The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

                                                      ShortName of the publisher/steward (organization or individual)
                                                      Comments

                                                      Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.

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

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

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

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

                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      80. 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 comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

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

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

                                                      ShortThe context that the content is intended to support
                                                      Comments

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

                                                      Control0..*
                                                      TypeUsageContext
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Requirements

                                                      Assist in searching for appropriate content.

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

                                                      DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

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

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

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

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

                                                      ShortWhy this plan definition is defined
                                                      Comments

                                                      This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.

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

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

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

                                                      The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

                                                      Control0..1
                                                      Typemarkdown
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

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

                                                      Alternate NamesLicense, Restrictions
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      92. PlanDefinition.copyrightLabel
                                                      Definition

                                                      A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

                                                      ShortCopyright holder and year(s)
                                                      Comments

                                                      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
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

                                                      Defines the content expected to be rendered in all representations of the artifact.

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

                                                      The date on which the FDA approval status for a specification became effective. [Source: SME Defined] Note: If the application is not yet approved, then this is the date of the current submission OR the date of the complete response (CR). Note: This is not the application approval status date.

                                                      ShortSpecification Status Date
                                                      Comments

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

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

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

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

                                                      ShortWhen the plan definition was last reviewed by the publisher
                                                      Comments

                                                      If specified, this date follows the original approval date.

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

                                                      Control0..1
                                                      Typedate
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

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

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      98. 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 plan definition intended to be used for the year 2016 might be published in 2015.

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

                                                      Control0..1
                                                      TypePeriod
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Requirements

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

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

                                                      DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

                                                      Control0..*
                                                      BindingFor example codes, see DefinitionTopic
                                                      (example to http://hl7.org/fhir/ValueSet/definition-topic)

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

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

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

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

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

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

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

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

                                                      An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

                                                      ShortWho reviewed the content
                                                      Comments

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

                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      108. PlanDefinition.endorser
                                                      Definition

                                                      An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

                                                      ShortWho endorsed the content
                                                      Comments

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

                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      110. PlanDefinition.relatedArtifact
                                                      Definition

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

                                                      ShortAdditional documentation, citations
                                                      Comments

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

                                                      Control0..*
                                                      TypeRelatedArtifact
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

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

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

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

                                                      ShortLogic used by the plan definition
                                                      Control0..*
                                                      Typecanonical(Library)
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      114. PlanDefinition.goal
                                                      Definition

                                                      A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, etc.

                                                      ShortAcceptance Criteria
                                                      Control0..*
                                                      This element is affected by the following invariants: pld-3
                                                      TypeBackboneElement
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Requirements

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

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

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      118. PlanDefinition.goal.extension
                                                      Definition

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

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      120. PlanDefinition.goal.modifierExtension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                      Indicates a category the goal falls within.

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

                                                      Example codes for grouping goals for filtering or presentation.

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

                                                      The text of the acceptance criteria as provided in the specification. [Source: SME Defined] Examples: White to off-white cake; 22.5 - 27.5 mg/ml Note: This is the text as it appears in the Specification.

                                                      ShortOriginal Text
                                                      Comments

                                                      If no code is available, use CodeableConcept.text.

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

                                                      Describes goals that can be achieved.

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

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

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

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

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

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

                                                      ShortWhat does the goal address
                                                      Control1..*
                                                      BindingFor example codes, see ConditionProblemDiagnosisCodes
                                                      (example to http://hl7.org/fhir/ValueSet/condition-code)

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

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

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      134. PlanDefinition.goal.addresses.extension
                                                      Definition

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

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                        A reference to a code defined by a terminology system.

                                                        ShortCode defined by a terminology system
                                                        Comments

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

                                                        Control0..*
                                                        TypeCoding
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Requirements

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

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

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

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        140. PlanDefinition.goal.addresses.coding.extension
                                                        Definition

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

                                                        ShortAdditional content defined by implementations
                                                        Comments

                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

                                                          ShortIdentity of the terminology system
                                                          Comments

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

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

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

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

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

                                                          ShortVersion of the system - if relevant
                                                          Comments

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

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

                                                          A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability. Note: The concept of 'In-Process' is subsumed by the Release code.

                                                          ShortAcceptance Criteria Usage
                                                          Control1..1
                                                          This element is affected by the following invariants: cod-1
                                                          BindingThe codes SHALL be taken from Test Usage Terminology
                                                          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-usage-terminology)
                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Requirements

                                                          Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                          ShortIf this coding was chosen directly by the user
                                                          Comments

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

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

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

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

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

                                                          ShortAccpetance Criteria Usage
                                                          Comments

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

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

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

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

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

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

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

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          158. PlanDefinition.goal.documentation.extension
                                                          Definition

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

                                                          ShortAdditional content defined by implementations
                                                          Comments

                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                            The type of relationship to the related artifact.

                                                            Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                                                            Comments

                                                            The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                                                            Control1..1
                                                            BindingThe codes SHALL be taken from RelatedArtifactType
                                                            (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                                                            The type of relationship to the related artifact.

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Pattern Valuecomments-on
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            162. PlanDefinition.goal.documentation.classifier
                                                            Definition

                                                            Provides additional classifiers of the related artifact.

                                                            ShortAdditional classifiers
                                                            Control0..*
                                                            BindingFor example codes, see CitationArtifactClassifier
                                                            (example to http://hl7.org/fhir/ValueSet/citation-artifact-classifier)

                                                            Additional classifiers for the related artifact.

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

                                                            A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

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

                                                            A textual field to provide any additional information about the acceptance criteria. [Source: SME Defined] Example: value changed from 4% to 5% on 01/01/2010)

                                                            ShortAcceptance Criteria Additional Information
                                                            Control1..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            168. PlanDefinition.goal.documentation.citation
                                                            Definition

                                                            A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

                                                            ShortBibliographic citation for the artifact
                                                            Comments

                                                            Additional structured information about citations should be captured as extensions.

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

                                                            The document being referenced, represented as an attachment. This is exclusive with the resource element.

                                                            ShortWhat document is being referenced
                                                            Control0..1
                                                            TypeAttachment
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            172. PlanDefinition.goal.documentation.resource
                                                            Definition

                                                            The related artifact, such as a library, value set, profile, or other knowledge resource.

                                                            ShortWhat artifact is being referenced
                                                            Comments

                                                            If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

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

                                                            The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

                                                            ShortWhat artifact, if not a conformance resource
                                                            Comments

                                                            If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

                                                            Control0..1
                                                            TypeReference(Resource)
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            176. PlanDefinition.goal.documentation.publicationStatus
                                                            Definition

                                                            The publication status of the artifact being referred to.

                                                            Shortdraft | active | retired | unknown
                                                            Control0..1
                                                            BindingThe codes SHALL be taken from PublicationStatus
                                                            (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

                                                            Publication status of an artifact being referred to.

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

                                                            The date of publication of the artifact being referred to.

                                                            ShortDate of publication of the artifact being referred to
                                                            Control0..1
                                                            Typedate
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            180. PlanDefinition.goal.target
                                                            Definition

                                                            Indicates what should be done and within what timeframe.

                                                            ShortAcceptance Criteron
                                                            Control1..*
                                                            TypeBackboneElement
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            182. PlanDefinition.goal.target.id
                                                            Definition

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            184. PlanDefinition.goal.target.extension
                                                            Definition

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

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            186. PlanDefinition.goal.target.modifierExtension
                                                            Definition

                                                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

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

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

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

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            Typeid
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            192. PlanDefinition.goal.target.measure.extension
                                                            Definition

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

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                              A reference to a code defined by a terminology system.

                                                              ShortCode defined by a terminology system
                                                              Comments

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

                                                              Control0..*
                                                              TypeCoding
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Requirements

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

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

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

                                                              ShortDetailed parameter being measured if more granular than Sub-Test
                                                              Comments

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

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

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

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              198. 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%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                                                              ShortThe target value to be achieved
                                                              Comments

                                                              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
                                                              TypeChoice of: Quantity, Range, CodeableConcept, integer
                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                                                              • type @ $this
                                                              • 200. PlanDefinition.goal.target.detail[x]:detailQuantity
                                                                Slice NamedetailQuantity
                                                                Definition

                                                                The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]

                                                                ShortValueNumeric
                                                                Comments

                                                                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
                                                                TypeQuantity
                                                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                202. PlanDefinition.goal.target.detail[x]:detailQuantity.id
                                                                Definition

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                204. PlanDefinition.goal.target.detail[x]:detailQuantity.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control1..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 206. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode
                                                                  Slice NameinterpretationCode
                                                                  Definition

                                                                  A code that describes how to relate the given value to an acceptance value.

                                                                  ShortInterpretation Code
                                                                  Control1..1
                                                                  TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  208. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  Typeid
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  210. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.extension
                                                                  Definition

                                                                  An Extension

                                                                  ShortExtension
                                                                  Control0..0
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 212. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.url
                                                                    Definition

                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                    Shortidentifies the meaning of the extension
                                                                    Comments

                                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                    Control1..1
                                                                    Typeuri
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                                                                    214. PlanDefinition.goal.target.detail[x]:detailQuantity.extension:interpretationCode.value[x]
                                                                    Definition

                                                                    A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

                                                                    ShortInterpretation Code
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ext-1
                                                                    BindingThe codes SHALL be taken from Interpretation Code Terminology
                                                                    (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                                                    TypeCodeableConcept
                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    216. PlanDefinition.goal.target.detail[x]:detailQuantity.value
                                                                    Definition

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

                                                                    ShortNumerical value (with implicit precision)
                                                                    Comments

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

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

                                                                    Precision is handled implicitly in almost all cases of measurement.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    218. PlanDefinition.goal.target.detail[x]:detailQuantity.comparator
                                                                    Definition

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

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

                                                                    How the Quantity should be understood and represented.

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

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

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

                                                                    A human-readable form of the unit.

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    222. PlanDefinition.goal.target.detail[x]:detailQuantity.system
                                                                    Definition

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

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

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    224. PlanDefinition.goal.target.detail[x]:detailQuantity.code
                                                                    Definition

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

                                                                    ShortCoded form of the unit
                                                                    Comments

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

                                                                    Control1..1
                                                                    This element is affected by the following invariants: qty-3
                                                                    BindingThe codes SHALL be taken from Units Of Measure Terminology
                                                                    (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                                                                    Typecode
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supporttrue
                                                                    Summarytrue
                                                                    Requirements

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    226. PlanDefinition.goal.target.detail[x]:detailRange
                                                                    Slice NamedetailRange
                                                                    Definition

                                                                    The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]

                                                                    ShortValueNumeric (range)
                                                                    Comments

                                                                    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
                                                                    TypeRange
                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    228. PlanDefinition.goal.target.detail[x]:detailRange.id
                                                                    Definition

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typeid
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    230. PlanDefinition.goal.target.detail[x]:detailRange.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                      The low limit. The boundary is inclusive.

                                                                      ShortLow limit
                                                                      Comments

                                                                      If the low element is missing, the low boundary is not known.

                                                                      Control1..1
                                                                      This element is affected by the following invariants: rng-2
                                                                      TypeQuantity(SimpleQuantity)
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      234. PlanDefinition.goal.target.detail[x]:detailRange.low.id
                                                                      Definition

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      236. PlanDefinition.goal.target.detail[x]:detailRange.low.extension
                                                                      Definition

                                                                      An Extension

                                                                      ShortExtension
                                                                      Control1..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].low.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 238. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow
                                                                        Slice NameinterpretationCodeLow
                                                                        Definition

                                                                        A code that describes how to relate the given value to an acceptance value.

                                                                        ShortInterpretation Code
                                                                        Control1..1
                                                                        TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        240. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.id
                                                                        Definition

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        This element is affected by the following invariants: ele-1
                                                                        Typeid
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        242. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..0
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].low.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 244. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.url
                                                                          Definition

                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                          Shortidentifies the meaning of the extension
                                                                          Comments

                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                          Control1..1
                                                                          Typeuri
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                                                                          246. PlanDefinition.goal.target.detail[x]:detailRange.low.extension:interpretationCodeLow.value[x]
                                                                          Definition

                                                                          A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

                                                                          ShortInterpretation Code
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ext-1
                                                                          BindingThe codes SHALL be taken from Interpretation Code Terminology
                                                                          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                                                          TypeCodeableConcept
                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          248. PlanDefinition.goal.target.detail[x]:detailRange.low.value
                                                                          Definition

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

                                                                          ShortNumerical value (with implicit precision)
                                                                          Comments

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

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

                                                                          Precision is handled implicitly in almost all cases of measurement.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          250. PlanDefinition.goal.target.detail[x]:detailRange.low.comparator
                                                                          Definition

                                                                          Not allowed to be used in this context

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

                                                                          How the Quantity should be understood and represented.

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

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

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

                                                                          A human-readable form of the unit.

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

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          254. PlanDefinition.goal.target.detail[x]:detailRange.low.system
                                                                          Definition

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

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

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          256. PlanDefinition.goal.target.detail[x]:detailRange.low.code
                                                                          Definition

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

                                                                          ShortCoded form of the unit
                                                                          Comments

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

                                                                          Control1..1
                                                                          This element is affected by the following invariants: qty-3
                                                                          BindingThe codes SHALL be taken from Units Of Measure Terminology
                                                                          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Summarytrue
                                                                          Requirements

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          258. PlanDefinition.goal.target.detail[x]:detailRange.high
                                                                          Definition

                                                                          The high limit. The boundary is inclusive.

                                                                          ShortHigh limit
                                                                          Comments

                                                                          If the high element is missing, the high boundary is not known.

                                                                          Control1..1
                                                                          This element is affected by the following invariants: rng-2
                                                                          TypeQuantity(SimpleQuantity)
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          260. PlanDefinition.goal.target.detail[x]:detailRange.high.id
                                                                          Definition

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ele-1
                                                                          Typeid
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          262. PlanDefinition.goal.target.detail[x]:detailRange.high.extension
                                                                          Definition

                                                                          An Extension

                                                                          ShortExtension
                                                                          Control1..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].high.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 264. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh
                                                                            Slice NameinterpretationCodeHigh
                                                                            Definition

                                                                            A code that describes how to relate the given value to an acceptance value.

                                                                            ShortInterpretation Code
                                                                            Control1..1
                                                                            TypeExtension(Interpretation Code) (Extension Type: CodeableConcept)
                                                                            Is Modifierfalse
                                                                            Must Supporttrue
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            266. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            Typeid
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            268. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.extension
                                                                            Definition

                                                                            An Extension

                                                                            ShortExtension
                                                                            Control0..0
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on PlanDefinition.goal.target.detail[x].high.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 270. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.url
                                                                              Definition

                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                              Shortidentifies the meaning of the extension
                                                                              Comments

                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                              Control1..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-interpretation-code-extension
                                                                              272. PlanDefinition.goal.target.detail[x]:detailRange.high.extension:interpretationCodeHigh.value[x]
                                                                              Definition

                                                                              A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary; when result value is textual the vocabulary is Pass/Fail.

                                                                              ShortInterpretation Code
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ext-1
                                                                              BindingThe codes SHALL be taken from Interpretation Code Terminology
                                                                              (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                                                              TypeCodeableConcept
                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              274. PlanDefinition.goal.target.detail[x]:detailRange.high.value
                                                                              Definition

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

                                                                              ShortNumerical value (with implicit precision)
                                                                              Comments

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

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

                                                                              Precision is handled implicitly in almost all cases of measurement.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              276. PlanDefinition.goal.target.detail[x]:detailRange.high.comparator
                                                                              Definition

                                                                              Not allowed to be used in this context

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

                                                                              How the Quantity should be understood and represented.

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

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

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

                                                                              A human-readable form of the unit.

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

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              280. PlanDefinition.goal.target.detail[x]:detailRange.high.system
                                                                              Definition

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

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

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              282. PlanDefinition.goal.target.detail[x]:detailRange.high.code
                                                                              Definition

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

                                                                              ShortCoded form of the unit
                                                                              Comments

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

                                                                              Control1..1
                                                                              This element is affected by the following invariants: qty-3
                                                                              BindingThe codes SHALL be taken from Units Of Measure Terminology
                                                                              (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology)
                                                                              Typecode
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Requirements

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              284. PlanDefinition.goal.target.detail[x]:detailCodeableConcept
                                                                              Slice NamedetailCodeableConcept
                                                                              Definition

                                                                              The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                                                                              ShortThe target value to be achieved
                                                                              Comments

                                                                              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
                                                                              TypeCodeableConcept
                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              286. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.id
                                                                              Definition

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ele-1
                                                                              Typeid
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              288. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.extension
                                                                              Definition

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

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                A code that describes how to relate the given value to an acceptance value. [Source: SME Defined] Note: When result value is numeric there is a controlled vocabulary.

                                                                                ShortInterpretation Code
                                                                                Comments

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

                                                                                Control1..1
                                                                                BindingThe codes SHALL be taken from Interpretation Code Terminology
                                                                                (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-interpretation-code-terminology)
                                                                                TypeCoding
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Summarytrue
                                                                                Requirements

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

                                                                                Pattern Value{
                                                                                  "system" : "http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy",
                                                                                  "code" : "C48793",
                                                                                  "display" : "EQ"
                                                                                }
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                292. PlanDefinition.goal.target.detail[x]:detailCodeableConcept.text
                                                                                Definition

                                                                                A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - USP <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

                                                                                ShortValue
                                                                                Comments

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

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

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

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                294. PlanDefinition.goal.target.detail[x]:detailInteger
                                                                                Slice NamedetailInteger
                                                                                Definition

                                                                                An identification number for a member of the set of results for a test, usually the sequence order in which the test was executed. Individual tests are executed on multiple samples to give greater validity to the findings. [Source SME Defined] Examples: Prepare six aliquots from the sample. Test 8 samples. If any fall above 110%, test an additional 7 samples. Record all replicate values as stated in the method.

                                                                                ShortNumber of Replicates
                                                                                Comments

                                                                                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
                                                                                Typeinteger
                                                                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                296. 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..0
                                                                                TypeDuration
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                298. PlanDefinition.actor
                                                                                Definition

                                                                                Actors represent the individuals or groups involved in the execution of the defined set of activities.

                                                                                ShortActors within the plan
                                                                                Control0..*
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                300. PlanDefinition.actor.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                302. PlanDefinition.actor.extension
                                                                                Definition

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

                                                                                ShortAdditional content defined by implementations
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                304. PlanDefinition.actor.modifierExtension
                                                                                Definition

                                                                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                A descriptive label for the actor.

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

                                                                                A description of how the actor fits into the overall actions of the plan definition.

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

                                                                                The characteristics of the candidates that could serve as the actor.

                                                                                ShortWho or what can be this actor
                                                                                Control1..*
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                312. PlanDefinition.actor.option.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                314. PlanDefinition.actor.option.extension
                                                                                Definition

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

                                                                                ShortAdditional content defined by implementations
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                316. PlanDefinition.actor.option.modifierExtension
                                                                                Definition

                                                                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                The type of participant in the action.

                                                                                Shortcareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                                                                                Control0..1
                                                                                BindingThe codes SHALL be taken from ActionParticipantType
                                                                                (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0)

                                                                                The type of participant in the activity.

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

                                                                                The type of participant in the action.

                                                                                ShortWho or what can participate
                                                                                Control0..1
                                                                                Typecanonical(CapabilityStatement)
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                322. PlanDefinition.actor.option.typeReference
                                                                                Definition

                                                                                The type of participant in the action.

                                                                                ShortWho or what can participate
                                                                                Comments

                                                                                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
                                                                                TypeReference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                324. PlanDefinition.actor.option.role
                                                                                Definition

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

                                                                                ShortE.g. Nurse, Surgeon, Parent
                                                                                Control0..1
                                                                                BindingFor example codes, see Action Participant Role
                                                                                (example to http://terminology.hl7.org/ValueSet/action-participant-role)
                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                326. PlanDefinition.action
                                                                                Definition

                                                                                An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

                                                                                ShortMethod
                                                                                Comments

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

                                                                                Control1..*
                                                                                This element is affected by the following invariants: pld-3, pld-4
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                cmc-link-required: Action linkId is required for alternate tests ((action.relatedAction.count() > 0) implies action.linkId.exists())
                                                                                cmc-single-or-multistage: if a test is multi-stage, the test can't have a prefix and its stages must have a name and can't be named 'Single Stage' and must be unique. If it's single stage its prefix is 'Single Stage' and its groups can't have prefixes ((( prefix.exists() implies action.prefix.empty() and prefix = 'Single Stage' ) and ( prefix.empty() implies ( (action.where( prefix.exists() and prefix != 'Single Stage' ).count() = action.count()) and action.prefix.isDistinct() ) )) = true)
                                                                                328. PlanDefinition.action.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                330. PlanDefinition.action.extension
                                                                                Definition

                                                                                An Extension

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

                                                                                  Test Order: The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] [Source: SME Defined] Examples: 1, 2, 3.

                                                                                  ShortTest Order
                                                                                  Control1..1
                                                                                  TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                                                                  Is Modifierfalse
                                                                                  Must Supporttrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  334. PlanDefinition.action.extension:testOrder.id
                                                                                  Definition

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

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..1
                                                                                  This element is affected by the following invariants: ele-1
                                                                                  Typeid
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  336. PlanDefinition.action.extension:testOrder.extension
                                                                                  Definition

                                                                                  An Extension

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

                                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                                    Shortidentifies the meaning of the extension
                                                                                    Comments

                                                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                    Control1..1
                                                                                    Typeuri
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                                                                    340. PlanDefinition.action.extension:testOrder.value[x]
                                                                                    Definition

                                                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                    ShortValue of extension
                                                                                    Control1..1
                                                                                    This element is affected by the following invariants: ext-1
                                                                                    Typedecimal
                                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                                                                    342. PlanDefinition.action.modifierExtension
                                                                                    Definition

                                                                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                    An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

                                                                                    Shortonly required for alternate tests
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    346. PlanDefinition.action.prefix
                                                                                    Definition

                                                                                    A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

                                                                                    Implememtation Note: Value at this level is 'Single Stage'

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

                                                                                    The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor

                                                                                    ShortTest Name
                                                                                    Control1..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    350. PlanDefinition.action.description
                                                                                    Definition

                                                                                    Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. If there is more than one comment, include in this element. Markdown allows formating for clarity.

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

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

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

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

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

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

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

                                                                                    A coded value specifying the source of the method. [Source: SME Defined] Example: Compendial

                                                                                    ShortTest Method Origin
                                                                                    Control1..1
                                                                                    BindingFor example codes, see ActionCode
                                                                                    (example to http://hl7.org/fhir/ValueSet/action-code)

                                                                                    Provides examples of actions to be performed.

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

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

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    This element is affected by the following invariants: ele-1
                                                                                    Typeid
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    360. PlanDefinition.action.code.extension
                                                                                    Definition

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

                                                                                    ShortAdditional content defined by implementations
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                      A reference to a code defined by a terminology system.

                                                                                      ShortCode defined by a terminology system
                                                                                      Comments

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

                                                                                      Control0..*
                                                                                      TypeCoding
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Requirements

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

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

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

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      This element is affected by the following invariants: ele-1
                                                                                      Typeid
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      366. PlanDefinition.action.code.coding.extension
                                                                                      Definition

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

                                                                                      ShortAdditional content defined by implementations
                                                                                      Comments

                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

                                                                                        ShortIdentity of the terminology system
                                                                                        Comments

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

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

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

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

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

                                                                                        ShortVersion of the system - if relevant
                                                                                        Comments

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

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

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

                                                                                        ShortSymbol in syntax defined by the system
                                                                                        Control1..1
                                                                                        This element is affected by the following invariants: cod-1
                                                                                        BindingThe codes SHALL be taken from Test Method Origin Terminology
                                                                                        (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-method-origin-terminology)
                                                                                        Typecode
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Must Supporttrue
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                                                        ShortIf this coding was chosen directly by the user
                                                                                        Comments

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

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

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

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

                                                                                        The name of the technique used to determine the nature of a characteristic. [Source: SME Defined].

                                                                                        ShortAnalytical Procedure
                                                                                        Comments

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

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

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

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

                                                                                        A high level grouping of quality attributes for products, substances, raw materials, excipients, intermediates and reagents. [Source: SME Defined] Examples: Assay, Biological Properties.

                                                                                        ShortTest Category | Test Subcategory
                                                                                        Comments

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

                                                                                        Control1..2
                                                                                        BindingFor example codes, see ActionReasonCode
                                                                                        (example to http://hl7.org/fhir/ValueSet/action-reason-code)

                                                                                        Provides examples of reasons for actions to be performed.

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

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        Typeid
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        384. PlanDefinition.action.reason.extension
                                                                                        Definition

                                                                                        An Extension

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

                                                                                          Numeric level in the hierarchical value-set

                                                                                          ShortHierarchical Level
                                                                                          Control1..1
                                                                                          TypeExtension(Hierarchical Level) (Extension Type: integer)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          388. PlanDefinition.action.reason.coding
                                                                                          Definition

                                                                                          A reference to a code defined by a terminology system.

                                                                                          ShortCode defined by a terminology system
                                                                                          Comments

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

                                                                                          Control0..*
                                                                                          BindingThe codes SHALL be taken from Test Category Terminology
                                                                                          (required to http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-category-terminology)
                                                                                          TypeCoding
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summarytrue
                                                                                          Requirements

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

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

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

                                                                                          ShortUnique id for inter-element referencing
                                                                                          Control0..1
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          Typeid
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          392. PlanDefinition.action.reason.coding.extension
                                                                                          Definition

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

                                                                                          ShortAdditional content defined by implementations
                                                                                          Comments

                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

                                                                                            ShortIdentity of the terminology system
                                                                                            Comments

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

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

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

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

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

                                                                                            ShortVersion of the system - if relevant
                                                                                            Comments

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

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

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

                                                                                            ShortSymbol in syntax defined by the system
                                                                                            Control1..1
                                                                                            This element is affected by the following invariants: cod-1
                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supporttrue
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            Need to refer to a particular code in the system.

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

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

                                                                                            ShortRepresentation defined by the system
                                                                                            Control1..1
                                                                                            This element is affected by the following invariants: cod-1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Requirements

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

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

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

                                                                                            ShortIf this coding was chosen directly by the user
                                                                                            Comments

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

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

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

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

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

                                                                                            ShortPlain text representation of the concept
                                                                                            Comments

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

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

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

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            406. 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..1
                                                                                            TypeRelatedArtifact
                                                                                            Is Modifierfalse
                                                                                            Must Supporttrue
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            408. PlanDefinition.action.documentation.id
                                                                                            Definition

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

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            This element is affected by the following invariants: ele-1
                                                                                            Typeid
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            410. PlanDefinition.action.documentation.extension
                                                                                            Definition

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

                                                                                            ShortAdditional content defined by implementations
                                                                                            Comments

                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                              The type of relationship to the related artifact.

                                                                                              Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                                                                                              Comments

                                                                                              The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                                                                                              Control1..1
                                                                                              BindingThe codes SHALL be taken from RelatedArtifactType
                                                                                              (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                                                                                              The type of relationship to the related artifact.

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

                                                                                              Provides additional classifiers of the related artifact.

                                                                                              ShortAdditional classifiers
                                                                                              Control0..*
                                                                                              BindingFor example codes, see CitationArtifactClassifier
                                                                                              (example to http://hl7.org/fhir/ValueSet/citation-artifact-classifier)

                                                                                              Additional classifiers for the related artifact.

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

                                                                                              A sponsor/applicant provided alphanumeric code that identifies the procedure. [Source: SME Defined]. Example: HP1234-2008 Note: This could also be a transferred lab method.

                                                                                              ShortReference to Procedure
                                                                                              Control1..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supporttrue
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              418. PlanDefinition.action.documentation.display
                                                                                              Definition

                                                                                              A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

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

                                                                                              A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

                                                                                              ShortBibliographic citation for the artifact
                                                                                              Comments

                                                                                              Additional structured information about citations should be captured as extensions.

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

                                                                                              The document being referenced, represented as an attachment. This is exclusive with the resource element.

                                                                                              ShortWhat document is being referenced
                                                                                              Control0..1
                                                                                              TypeAttachment
                                                                                              Is Modifierfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              424. PlanDefinition.action.documentation.resource
                                                                                              Definition

                                                                                              The related artifact, such as a library, value set, profile, or other knowledge resource.

                                                                                              ShortWhat artifact is being referenced
                                                                                              Comments

                                                                                              If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

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

                                                                                              The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

                                                                                              ShortWhat artifact, if not a conformance resource
                                                                                              Comments

                                                                                              If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

                                                                                              Control0..1
                                                                                              TypeReference(Resource)
                                                                                              Is Modifierfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              428. PlanDefinition.action.documentation.publicationStatus
                                                                                              Definition

                                                                                              The publication status of the artifact being referred to.

                                                                                              Shortdraft | active | retired | unknown
                                                                                              Control0..1
                                                                                              BindingThe codes SHALL be taken from PublicationStatus
                                                                                              (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

                                                                                              Publication status of an artifact being referred to.

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

                                                                                              The date of publication of the artifact being referred to.

                                                                                              ShortDate of publication of the artifact being referred to
                                                                                              Control0..1
                                                                                              Typedate
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              432. PlanDefinition.action.goalId
                                                                                              Definition

                                                                                              Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                                                                              ShortReference to Acceptance Criteria
                                                                                              Control0..*
                                                                                              This element is affected by the following invariants: pld-3
                                                                                              Typeid
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supporttrue
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              434. PlanDefinition.action.subject[x]
                                                                                              Definition

                                                                                              A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

                                                                                              ShortType of individual the action is focused on
                                                                                              Comments

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

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

                                                                                              Control0..1
                                                                                              BindingUnless not suitable, these codes SHALL be taken from ParticipantResourceTypes
                                                                                              (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types)

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

                                                                                              TypeChoice of: CodeableConcept, Reference(Group), canonical
                                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

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

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

                                                                                              A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

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

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

                                                                                              ShortWhether or not the action is applicable
                                                                                              Comments

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

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

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              442. PlanDefinition.action.condition.extension
                                                                                              Definition

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              444. PlanDefinition.action.condition.modifierExtension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              The kind of condition.

                                                                                              Shortapplicability | start | stop
                                                                                              Comments

                                                                                              Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

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

                                                                                              Defines the kinds of conditions that can appear on actions.

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

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

                                                                                              ShortBoolean-valued expression
                                                                                              Comments

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

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

                                                                                              Defines input data requirements for the action.

                                                                                              ShortInput data requirements
                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              pld-0: Input data elements must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                              452. 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.

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              454. PlanDefinition.action.input.extension
                                                                                              Definition

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              456. PlanDefinition.action.input.modifierExtension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

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

                                                                                              Defines the data that is to be provided as input to the action.

                                                                                              ShortWhat data is provided
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: pld-0
                                                                                              TypeDataRequirement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              462. PlanDefinition.action.input.relatedData
                                                                                              Definition

                                                                                              Points to an existing input or output element that provides data to this input.

                                                                                              ShortWhat data is provided
                                                                                              Comments

                                                                                              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
                                                                                              This element is affected by the following invariants: pld-0
                                                                                              Typeid
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              464. PlanDefinition.action.output
                                                                                              Definition

                                                                                              Defines the outputs of the action, if any.

                                                                                              ShortOutput data definition
                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              pld-1: Output data element must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                              466. 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.

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              468. PlanDefinition.action.output.extension
                                                                                              Definition

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              470. PlanDefinition.action.output.modifierExtension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

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

                                                                                              Defines the data that results as output from the action.

                                                                                              ShortWhat data is provided
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: pld-1
                                                                                              TypeDataRequirement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              476. PlanDefinition.action.output.relatedData
                                                                                              Definition

                                                                                              Points to an existing input or output element that is results as output from the action.

                                                                                              ShortWhat data is provided
                                                                                              Comments

                                                                                              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
                                                                                              This element is affected by the following invariants: pld-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              478. PlanDefinition.action.relatedAction
                                                                                              Definition

                                                                                              Alternate Tests are one or more test that are equivalent often using differnt method or equipment. The tests are used interchangeably and only one is used to satisfy the drug product specificaion.

                                                                                              ShortAlternate Test
                                                                                              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..*
                                                                                              This element is affected by the following invariants: pld-4
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supporttrue
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              480. PlanDefinition.action.relatedAction.id
                                                                                              Definition

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              482. PlanDefinition.action.relatedAction.extension
                                                                                              Definition

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              The element id of the target related action.

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

                                                                                              The relationship of the start of this action to the related action.

                                                                                              ShortCode is concurrent
                                                                                              Control1..1
                                                                                              BindingThe codes SHALL be taken from ActionRelationshipType
                                                                                              (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0)

                                                                                              Defines the types of relationships between actions.

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

                                                                                              The relationship of the end of this action to the related action.

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

                                                                                              Defines the types of relationships between actions.

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              492. 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] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              494. PlanDefinition.action.timing[x]
                                                                                              Definition

                                                                                              An optional value describing when the action should be performed.

                                                                                              ShortWhen the action should take place
                                                                                              Comments

                                                                                              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
                                                                                              TypeChoice of: Age, Duration, Range, Timing
                                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Allows prompting for activities and detection of missed planned activities.

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

                                                                                              Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

                                                                                              ShortWhere it should happen
                                                                                              Comments

                                                                                              May reference a specific clinical location or may just identify a type of location.

                                                                                              Control0..1
                                                                                              TypeCodeableReference(Location)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Helps in planning of activity.

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

                                                                                              Indicates who should participate in performing the action described.

                                                                                              ShortWho should participate in the action
                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              500. PlanDefinition.action.participant.id
                                                                                              Definition

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

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

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              504. PlanDefinition.action.participant.modifierExtension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              A reference to the id element of the actor who will participate in this action.

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

                                                                                              The type of participant in the action.

                                                                                              Shortcareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                                                                                              Control0..1
                                                                                              BindingThe codes SHALL be taken from ActionParticipantType
                                                                                              (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0)

                                                                                              The type of participant in the activity.

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

                                                                                              The type of participant in the action.

                                                                                              ShortWho or what can participate
                                                                                              Control0..1
                                                                                              Typecanonical(CapabilityStatement)
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              512. PlanDefinition.action.participant.typeReference
                                                                                              Definition

                                                                                              The type of participant in the action.

                                                                                              ShortWho or what can participate
                                                                                              Comments

                                                                                              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
                                                                                              TypeReference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              514. PlanDefinition.action.participant.role
                                                                                              Definition

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

                                                                                              ShortE.g. Nurse, Surgeon, Parent
                                                                                              Control0..1
                                                                                              BindingFor example codes, see Action Participant Role
                                                                                              (example to http://terminology.hl7.org/ValueSet/action-participant-role)

                                                                                              Defines roles played by participants for the action.

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

                                                                                              Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

                                                                                              ShortE.g. Author, Reviewer, Witness, etc
                                                                                              Control0..1
                                                                                              BindingFor example codes, see ActionParticipantFunction
                                                                                              (example to http://hl7.org/fhir/ValueSet/action-participant-function)
                                                                                              TypeCodeableConcept
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              518. PlanDefinition.action.type
                                                                                              Definition

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

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

                                                                                              The type of action to be performed.

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

                                                                                              Defines organization behavior of a group.

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              522. PlanDefinition.action.selectionBehavior
                                                                                              Definition

                                                                                              Defines the selection behavior for the action and its children.

                                                                                              ShortCode is exactly-one
                                                                                              Control0..1
                                                                                              BindingThe codes SHALL be taken from ActionSelectionBehavior
                                                                                              (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0)

                                                                                              Defines selection behavior of a group.

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supporttrue
                                                                                              Summaryfalse
                                                                                              Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
                                                                                              Pattern Valueexactly-one
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              524. PlanDefinition.action.requiredBehavior
                                                                                              Definition

                                                                                              Defines the required behavior for the action.

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

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

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Meaning if MissingIf no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              526. 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|5.0.0)

                                                                                              Defines selection frequency behavior for an action or group.

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Meaning if MissingIf no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              528. 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|5.0.0)

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

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Meaning if MissingIf no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              530. PlanDefinition.action.definition[x]
                                                                                              Definition

                                                                                              A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

                                                                                              ShortDescription of the activity to be performed
                                                                                              Comments

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

                                                                                              Control0..1
                                                                                              TypeChoice of: canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri
                                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              532. PlanDefinition.action.transform
                                                                                              Definition

                                                                                              A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

                                                                                              ShortTransform to apply the template
                                                                                              Comments

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

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

                                                                                              Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

                                                                                              ShortDynamic aspects of the definition
                                                                                              Comments

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

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

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              538. PlanDefinition.action.dynamicValue.extension
                                                                                              Definition

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

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              540. PlanDefinition.action.dynamicValue.modifierExtension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                              The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                                                              ShortThe path to the element to be set dynamically
                                                                                              Comments

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

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

                                                                                              An expression specifying the value of the customized element.

                                                                                              ShortAn expression that provides the dynamic value for the customization
                                                                                              Comments

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

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

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

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              550. PlanDefinition.action.action.extension
                                                                                              Definition

                                                                                              An Extension

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

                                                                                                The order of the stages in regular succession. [Source: SME Defined] Examples: 1, 2, 3.

                                                                                                ShortStage Sequence Order
                                                                                                Control1..1
                                                                                                TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                                                                                Is Modifierfalse
                                                                                                Must Supporttrue
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                554. PlanDefinition.action.action.extension:stageOrder.id
                                                                                                Definition

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

                                                                                                ShortUnique id for inter-element referencing
                                                                                                Control0..1
                                                                                                This element is affected by the following invariants: ele-1
                                                                                                Typeid
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                556. PlanDefinition.action.action.extension:stageOrder.extension
                                                                                                Definition

                                                                                                An Extension

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

                                                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                                                  Shortidentifies the meaning of the extension
                                                                                                  Comments

                                                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                  Control1..1
                                                                                                  Typeuri
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                                                                                  560. PlanDefinition.action.action.extension:stageOrder.value[x]
                                                                                                  Definition

                                                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                  ShortValue of extension
                                                                                                  Control1..1
                                                                                                  This element is affected by the following invariants: ext-1
                                                                                                  Typedecimal
                                                                                                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Summaryfalse
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                                                                                  562. PlanDefinition.action.action.modifierExtension
                                                                                                  Definition

                                                                                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                  Comments

                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                  An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

                                                                                                  ShortUnique id for the action in the PlanDefinition
                                                                                                  Control0..1
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supportfalse
                                                                                                  Summaryfalse
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  566. PlanDefinition.action.action.prefix
                                                                                                  Definition

                                                                                                  A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>) Note: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)

                                                                                                  Implememtation Note: not requried if action.prefix is 'Single Stage'

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

                                                                                                  Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.

                                                                                                  ShortTest Name (only reqired if different than above)
                                                                                                  Control0..1
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Summaryfalse
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  570. PlanDefinition.action.action.description
                                                                                                  Definition

                                                                                                  Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].

                                                                                                  Implementation Note: If there is more than one comment, include in this element. Markdown allows formating for clarity.

                                                                                                  ShortTest Additional Information | Stage Additional Information
                                                                                                  Control0..1
                                                                                                  Typemarkdown
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Summaryfalse
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  572. PlanDefinition.action.action.textEquivalent
                                                                                                  Definition

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

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

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

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

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

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

                                                                                                  A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

                                                                                                  ShortCode representing the meaning of the action or sub-actions
                                                                                                  Control0..1
                                                                                                  BindingFor example codes, see ActionCode
                                                                                                  (example to http://hl7.org/fhir/ValueSet/action-code)

                                                                                                  Provides examples of actions to be performed.

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

                                                                                                  A description of why this action is necessary or appropriate.

                                                                                                  ShortWhy the action should be performed
                                                                                                  Comments

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

                                                                                                  Control0..*
                                                                                                  BindingFor example codes, see ActionReasonCode
                                                                                                  (example to http://hl7.org/fhir/ValueSet/action-reason-code)

                                                                                                  Provides examples of reasons for actions to be performed.

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

                                                                                                  Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

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

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

                                                                                                  ShortUnique id for inter-element referencing
                                                                                                  Control0..1
                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                  Typeid
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  584. PlanDefinition.action.action.documentation.extension
                                                                                                  Definition

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

                                                                                                  ShortAdditional content defined by implementations
                                                                                                  Comments

                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                                    The type of relationship to the related artifact.

                                                                                                    Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
                                                                                                    Comments

                                                                                                    The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

                                                                                                    Control1..1
                                                                                                    BindingThe codes SHALL be taken from RelatedArtifactType
                                                                                                    (required to http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0)

                                                                                                    The type of relationship to the related artifact.

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

                                                                                                    Provides additional classifiers of the related artifact.

                                                                                                    ShortAdditional classifiers
                                                                                                    Control0..*
                                                                                                    BindingFor example codes, see CitationArtifactClassifier
                                                                                                    (example to http://hl7.org/fhir/ValueSet/citation-artifact-classifier)

                                                                                                    Additional classifiers for the related artifact.

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

                                                                                                    A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

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

                                                                                                    A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

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

                                                                                                    A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

                                                                                                    ShortBibliographic citation for the artifact
                                                                                                    Comments

                                                                                                    Additional structured information about citations should be captured as extensions.

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

                                                                                                    Any visual data described andor referenced in additional informatation

                                                                                                    ShortTest or Stage Additional Information Visual Attachments
                                                                                                    Control1..1
                                                                                                    TypeAttachment
                                                                                                    Is Modifierfalse
                                                                                                    Must Supporttrue
                                                                                                    Summarytrue
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    598. PlanDefinition.action.action.documentation.document.id
                                                                                                    Definition

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

                                                                                                    ShortUnique id for inter-element referencing
                                                                                                    Control0..1
                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                    Typeid
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    600. PlanDefinition.action.action.documentation.document.extension
                                                                                                    Definition

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

                                                                                                    ShortAdditional content defined by implementations
                                                                                                    Comments

                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                                      Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                                                                                      ShortMime type of the content, with charset etc.
                                                                                                      Control1..1
                                                                                                      This element is affected by the following invariants: att-1
                                                                                                      BindingThe codes SHALL be taken from MimeTypes
                                                                                                      (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)

                                                                                                      BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supporttrue
                                                                                                      Summarytrue
                                                                                                      Requirements

                                                                                                      Processors of the data need to be able to know how to interpret the data.

                                                                                                      Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      604. PlanDefinition.action.action.documentation.document.language
                                                                                                      Definition

                                                                                                      The human language of the content. The value can be any valid value according to BCP 47.

                                                                                                      ShortHuman language of the content (BCP-47)
                                                                                                      Control0..1
                                                                                                      BindingThe codes SHALL be taken from AllLanguages
                                                                                                      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                                                                                      IETF language tag for a human language.

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

                                                                                                      Users need to be able to choose between the languages in a set of attachments.

                                                                                                      Example<br/><b>General</b>:en-AU
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      606. PlanDefinition.action.action.documentation.document.data
                                                                                                      Definition

                                                                                                      The actual data of the attachment - a sequence of bytes, base64 encoded.

                                                                                                      ShortData inline, base64ed
                                                                                                      Comments

                                                                                                      The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

                                                                                                      Control1..1
                                                                                                      This element is affected by the following invariants: att-1
                                                                                                      Typebase64Binary
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supporttrue
                                                                                                      Summaryfalse
                                                                                                      Requirements

                                                                                                      The data needs to able to be transmitted inline.

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

                                                                                                      A location where the data can be accessed.

                                                                                                      ShortUri where the data can be found
                                                                                                      Comments

                                                                                                      If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                                                                                                      The data needs to be transmitted by reference.

                                                                                                      Example<br/><b>General</b>:http://www.acme.com/logo-small.png
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      610. PlanDefinition.action.action.documentation.document.size
                                                                                                      Definition

                                                                                                      The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                                                                                      ShortNumber of bytes of content (if url provided)
                                                                                                      Comments

                                                                                                      The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                                                                                                      Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

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

                                                                                                      The calculated hash of the data using SHA-1. Represented using base64.

                                                                                                      ShortHash of the data (sha-1, base64ed)
                                                                                                      Comments

                                                                                                      The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                                                                                                      Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

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

                                                                                                      A format or abbreviation name that identifies a file structure. [Source: SME Defined] Used for the following: Analytical Instrument Data File Type, Impurity Analysis Graphic, Impurity Analytical Instrument Data File, Impurity Chemical Structure Data File, and Substance Structure Graphic.

                                                                                                      ShortDocument file name including the file extension
                                                                                                      Comments

                                                                                                      May sometimes be derived from the source filename.

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

                                                                                                      Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                                                                                      Example<br/><b>General</b>:Official Corporate Logo
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      616. PlanDefinition.action.action.documentation.document.creation
                                                                                                      Definition

                                                                                                      The date that the attachment was first created.

                                                                                                      ShortDate attachment was first created
                                                                                                      Control0..1
                                                                                                      TypedateTime
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summarytrue
                                                                                                      Requirements

                                                                                                      This is often tracked as an integrity issue for use of the attachment.

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

                                                                                                      Height of the image in pixels (photo/video).

                                                                                                      ShortHeight of the image in pixels (photo/video)
                                                                                                      Control0..1
                                                                                                      TypepositiveInt
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      620. PlanDefinition.action.action.documentation.document.width
                                                                                                      Definition

                                                                                                      Width of the image in pixels (photo/video).

                                                                                                      ShortWidth of the image in pixels (photo/video)
                                                                                                      Control0..1
                                                                                                      TypepositiveInt
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      622. PlanDefinition.action.action.documentation.document.frames
                                                                                                      Definition

                                                                                                      The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

                                                                                                      ShortNumber of frames if > 1 (photo)
                                                                                                      Comments

                                                                                                      if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

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

                                                                                                      The duration of the recording in seconds - for audio and video.

                                                                                                      ShortLength in seconds (audio / video)
                                                                                                      Comments

                                                                                                      The duration might differ from occurrencePeriod if recording was paused.

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

                                                                                                      The number of pages when printed.

                                                                                                      ShortNumber of printed pages
                                                                                                      Control0..1
                                                                                                      TypepositiveInt
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      628. PlanDefinition.action.action.documentation.resource
                                                                                                      Definition

                                                                                                      The related artifact, such as a library, value set, profile, or other knowledge resource.

                                                                                                      ShortWhat artifact is being referenced
                                                                                                      Comments

                                                                                                      If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

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

                                                                                                      The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

                                                                                                      ShortWhat artifact, if not a conformance resource
                                                                                                      Comments

                                                                                                      If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

                                                                                                      Control0..1
                                                                                                      TypeReference(Resource)
                                                                                                      Is Modifierfalse
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      632. PlanDefinition.action.action.documentation.publicationStatus
                                                                                                      Definition

                                                                                                      The publication status of the artifact being referred to.

                                                                                                      Shortdraft | active | retired | unknown
                                                                                                      Control0..1
                                                                                                      BindingThe codes SHALL be taken from PublicationStatus
                                                                                                      (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

                                                                                                      Publication status of an artifact being referred to.

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

                                                                                                      The date of publication of the artifact being referred to.

                                                                                                      ShortDate of publication of the artifact being referred to
                                                                                                      Control0..1
                                                                                                      Typedate
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      636. PlanDefinition.action.action.goalId
                                                                                                      Definition

                                                                                                      Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                                                                                      ShortReference to Acceptance Criteria
                                                                                                      Control0..*
                                                                                                      This element is affected by the following invariants: pld-3
                                                                                                      Typeid
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supporttrue
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      638. PlanDefinition.action.action.subject[x]
                                                                                                      Definition

                                                                                                      A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

                                                                                                      ShortType of individual the action is focused on
                                                                                                      Comments

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

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

                                                                                                      Control0..1
                                                                                                      BindingUnless not suitable, these codes SHALL be taken from ParticipantResourceTypes
                                                                                                      (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types)

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

                                                                                                      TypeChoice of: CodeableConcept, Reference(Group), canonical
                                                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Requirements

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

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

                                                                                                      A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

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

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

                                                                                                      ShortWhether or not the action is applicable
                                                                                                      Comments

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

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

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      646. PlanDefinition.action.action.condition.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      648. PlanDefinition.action.action.condition.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      The kind of condition.

                                                                                                      Shortapplicability | start | stop
                                                                                                      Comments

                                                                                                      Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

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

                                                                                                      Defines the kinds of conditions that can appear on actions.

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

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

                                                                                                      ShortBoolean-valued expression
                                                                                                      Comments

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

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

                                                                                                      Defines input data requirements for the action.

                                                                                                      ShortInput data requirements
                                                                                                      Control0..*
                                                                                                      TypeBackboneElement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      pld-0: Input data elements must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                                      656. PlanDefinition.action.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.

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      658. PlanDefinition.action.action.input.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      660. PlanDefinition.action.action.input.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

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

                                                                                                      Defines the data that is to be provided as input to the action.

                                                                                                      ShortWhat data is provided
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: pld-0
                                                                                                      TypeDataRequirement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      666. PlanDefinition.action.action.input.relatedData
                                                                                                      Definition

                                                                                                      Points to an existing input or output element that provides data to this input.

                                                                                                      ShortWhat data is provided
                                                                                                      Comments

                                                                                                      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
                                                                                                      This element is affected by the following invariants: pld-0
                                                                                                      Typeid
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      668. PlanDefinition.action.action.output
                                                                                                      Definition

                                                                                                      Defines the outputs of the action, if any.

                                                                                                      ShortOutput data definition
                                                                                                      Control0..*
                                                                                                      TypeBackboneElement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      pld-1: Output data element must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                                      670. PlanDefinition.action.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.

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      672. PlanDefinition.action.action.output.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      674. PlanDefinition.action.action.output.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

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

                                                                                                      Defines the data that results as output from the action.

                                                                                                      ShortWhat data is provided
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: pld-1
                                                                                                      TypeDataRequirement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      680. PlanDefinition.action.action.output.relatedData
                                                                                                      Definition

                                                                                                      Points to an existing input or output element that is results as output from the action.

                                                                                                      ShortWhat data is provided
                                                                                                      Comments

                                                                                                      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
                                                                                                      This element is affected by the following invariants: pld-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      682. PlanDefinition.action.action.relatedAction
                                                                                                      Definition

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

                                                                                                      ShortRelationship to another action
                                                                                                      Comments

                                                                                                      When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

                                                                                                      Control0..*
                                                                                                      This element is affected by the following invariants: pld-4
                                                                                                      TypeBackboneElement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      684. PlanDefinition.action.action.relatedAction.id
                                                                                                      Definition

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      686. PlanDefinition.action.action.relatedAction.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      688. PlanDefinition.action.action.relatedAction.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      The element id of the target related action.

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

                                                                                                      The relationship of the start of this action to the related action.

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

                                                                                                      Defines the types of relationships between actions.

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

                                                                                                      The relationship of the end of this action to the related action.

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

                                                                                                      Defines the types of relationships between actions.

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

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

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

                                                                                                      An optional value describing when the action should be performed.

                                                                                                      ShortWhen the action should take place
                                                                                                      Comments

                                                                                                      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
                                                                                                      TypeChoice of: Age, Duration, Range, Timing
                                                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Requirements

                                                                                                      Allows prompting for activities and detection of missed planned activities.

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

                                                                                                      Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

                                                                                                      ShortWhere it should happen
                                                                                                      Comments

                                                                                                      May reference a specific clinical location or may just identify a type of location.

                                                                                                      Control0..1
                                                                                                      TypeCodeableReference(Location)
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Requirements

                                                                                                      Helps in planning of activity.

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

                                                                                                      Indicates who should participate in performing the action described.

                                                                                                      ShortWho should participate in the action
                                                                                                      Control0..*
                                                                                                      TypeBackboneElement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      704. PlanDefinition.action.action.participant.id
                                                                                                      Definition

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      706. PlanDefinition.action.action.participant.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      708. PlanDefinition.action.action.participant.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      A reference to the id element of the actor who will participate in this action.

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

                                                                                                      The type of participant in the action.

                                                                                                      Shortcareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                                                                                                      Control0..1
                                                                                                      BindingThe codes SHALL be taken from ActionParticipantType
                                                                                                      (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0)

                                                                                                      The type of participant in the activity.

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

                                                                                                      The type of participant in the action.

                                                                                                      ShortWho or what can participate
                                                                                                      Control0..1
                                                                                                      Typecanonical(CapabilityStatement)
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      716. PlanDefinition.action.action.participant.typeReference
                                                                                                      Definition

                                                                                                      The type of participant in the action.

                                                                                                      ShortWho or what can participate
                                                                                                      Comments

                                                                                                      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
                                                                                                      TypeReference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      718. PlanDefinition.action.action.participant.role
                                                                                                      Definition

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

                                                                                                      ShortE.g. Nurse, Surgeon, Parent
                                                                                                      Control0..1
                                                                                                      BindingFor example codes, see Action Participant Role
                                                                                                      (example to http://terminology.hl7.org/ValueSet/action-participant-role)

                                                                                                      Defines roles played by participants for the action.

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

                                                                                                      Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

                                                                                                      ShortE.g. Author, Reviewer, Witness, etc
                                                                                                      Control0..1
                                                                                                      BindingFor example codes, see ActionParticipantFunction
                                                                                                      (example to http://hl7.org/fhir/ValueSet/action-participant-function)
                                                                                                      TypeCodeableConcept
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      722. PlanDefinition.action.action.type
                                                                                                      Definition

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

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

                                                                                                      The type of action to be performed.

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

                                                                                                      Defines the grouping behavior for the action and its children.

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

                                                                                                      Defines organization behavior of a group.

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      726. PlanDefinition.action.action.selectionBehavior
                                                                                                      Definition

                                                                                                      Defines the selection behavior for the action and its children.

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

                                                                                                      Defines selection behavior of a group.

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      728. PlanDefinition.action.action.requiredBehavior
                                                                                                      Definition

                                                                                                      Defines the required behavior for the action.

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

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

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Meaning if MissingIf no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      730. PlanDefinition.action.action.precheckBehavior
                                                                                                      Definition

                                                                                                      Defines whether the action should usually be preselected.

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

                                                                                                      Defines selection frequency behavior for an action or group.

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Meaning if MissingIf no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      732. PlanDefinition.action.action.cardinalityBehavior
                                                                                                      Definition

                                                                                                      Defines whether the action can be selected multiple times.

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

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

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Meaning if MissingIf no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      734. PlanDefinition.action.action.definition[x]
                                                                                                      Definition

                                                                                                      A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

                                                                                                      ShortDescription of the activity to be performed
                                                                                                      Comments

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

                                                                                                      Control0..1
                                                                                                      TypeChoice of: canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri
                                                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supportfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      736. PlanDefinition.action.action.transform
                                                                                                      Definition

                                                                                                      A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

                                                                                                      ShortTransform to apply the template
                                                                                                      Comments

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

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

                                                                                                      Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

                                                                                                      ShortDynamic aspects of the definition
                                                                                                      Comments

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

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

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      742. PlanDefinition.action.action.dynamicValue.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      744. PlanDefinition.action.action.dynamicValue.modifierExtension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                      The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                                                                      ShortThe path to the element to be set dynamically
                                                                                                      Comments

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

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

                                                                                                      An expression specifying the value of the customized element.

                                                                                                      ShortAn expression that provides the dynamic value for the customization
                                                                                                      Comments

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

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

                                                                                                      Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

                                                                                                      ShortSub-Test
                                                                                                      Control0..*
                                                                                                      TypeBackboneElement
                                                                                                      Is Modifierfalse
                                                                                                      Must Supporttrue
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      cmc-subtest-rrt: a subtest's prefix represents relative retention time, should it exist (prefix.exists() implies prefix.single() = 'RRT')
                                                                                                      752. PlanDefinition.action.action.action.id
                                                                                                      Definition

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      754. PlanDefinition.action.action.action.extension
                                                                                                      Definition

                                                                                                      An Extension

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

                                                                                                        The sequential number assigned to each Test to specify the order of display on the Quality Specification. [Source: SME Defined] Implementation note: This is a decimaal value. Number the nested test by inheriting the value action.extension[testOrder]. For example, if the action.extension[testOrder] equals 3, then the first action.action.action.extension[testOrder] would be 3.1.

                                                                                                        ShortTest Order
                                                                                                        Control1..1
                                                                                                        TypeExtension(Test Order | Stage Sequence Order) (Extension Type: decimal)
                                                                                                        Is Modifierfalse
                                                                                                        Must Supporttrue
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                        758. PlanDefinition.action.action.action.extension:testOrder.id
                                                                                                        Definition

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

                                                                                                        ShortUnique id for inter-element referencing
                                                                                                        Control0..1
                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                        Typeid
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        760. PlanDefinition.action.action.action.extension:testOrder.extension
                                                                                                        Definition

                                                                                                        An Extension

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

                                                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                                                          Shortidentifies the meaning of the extension
                                                                                                          Comments

                                                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                          Control1..1
                                                                                                          Typeuri
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          Fixed Valuehttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-order-extension
                                                                                                          764. PlanDefinition.action.action.action.extension:testOrder.value[x]
                                                                                                          Definition

                                                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                          ShortValue of extension
                                                                                                          Control1..1
                                                                                                          This element is affected by the following invariants: ext-1
                                                                                                          Typedecimal
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          cmc-greater-than-zero: Hierachial levels are greater than 0 (($this > 0) = true)
                                                                                                          766. PlanDefinition.action.action.action.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                          An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

                                                                                                          ShortUnique id for the action in the PlanDefinition
                                                                                                          Control0..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          770. PlanDefinition.action.action.action.prefix
                                                                                                          Definition

                                                                                                          RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

                                                                                                          Implementation Note: This value can only be 'RRT'. It is used to desinate that RRT value(s) expressed in action.action.action.title are relative retention times.

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

                                                                                                          Test Name: The textual description of a procedure or analytical method. [Source: SME Defined] Examples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities. Note: as defined by the sponsor Note: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.

                                                                                                          RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] Example: 1:23 (a ratio) Note: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.

                                                                                                          Implementation Note: For RRT, if there is a range associated with the unidentified peak then the range can be entered instead of indivual values. E.g.: 0.4 – 0.8.

                                                                                                          ShortTest Name | RRT (complex testing)
                                                                                                          Control1..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          774. PlanDefinition.action.action.action.description
                                                                                                          Definition

                                                                                                          Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]. Stage Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined] If there is more than one comment, include in this element. Markdown allows formating for clarity. If both types are present, indicate type.

                                                                                                          ShortTest Additional Information | Stage Additional Information
                                                                                                          Control0..1
                                                                                                          Typemarkdown
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          776. PlanDefinition.action.action.action.textEquivalent
                                                                                                          Definition

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

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

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

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

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

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

                                                                                                          A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

                                                                                                          ShortCode representing the meaning of the action or sub-actions
                                                                                                          Control0..1
                                                                                                          BindingFor example codes, see ActionCode
                                                                                                          (example to http://hl7.org/fhir/ValueSet/action-code)

                                                                                                          Provides examples of actions to be performed.

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

                                                                                                          A description of why this action is necessary or appropriate.

                                                                                                          ShortWhy the action should be performed
                                                                                                          Comments

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

                                                                                                          Control0..*
                                                                                                          BindingFor example codes, see ActionReasonCode
                                                                                                          (example to http://hl7.org/fhir/ValueSet/action-reason-code)

                                                                                                          Provides examples of reasons for actions to be performed.

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

                                                                                                          Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

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

                                                                                                          Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

                                                                                                          ShortReference to Acceptance Criteria
                                                                                                          Control1..*
                                                                                                          This element is affected by the following invariants: pld-3
                                                                                                          Typeid
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          788. PlanDefinition.action.action.action.subject[x]
                                                                                                          Definition

                                                                                                          A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

                                                                                                          ShortType of individual the action is focused on
                                                                                                          Comments

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

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

                                                                                                          Control0..1
                                                                                                          BindingUnless not suitable, these codes SHALL be taken from ParticipantResourceTypes
                                                                                                          (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types)

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

                                                                                                          TypeChoice of: CodeableConcept, Reference(Group), canonical
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Requirements

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

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

                                                                                                          A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

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

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

                                                                                                          ShortWhether or not the action is applicable
                                                                                                          Comments

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

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

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

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          796. PlanDefinition.action.action.action.condition.extension
                                                                                                          Definition

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

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          798. PlanDefinition.action.action.action.condition.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                          The kind of condition.

                                                                                                          Shortapplicability | start | stop
                                                                                                          Comments

                                                                                                          Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

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

                                                                                                          Defines the kinds of conditions that can appear on actions.

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

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

                                                                                                          ShortBoolean-valued expression
                                                                                                          Comments

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

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

                                                                                                          Defines input data requirements for the action.

                                                                                                          ShortInput data requirements
                                                                                                          Control0..*
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          pld-0: Input data elements must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                                          806. PlanDefinition.action.action.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.

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          808. PlanDefinition.action.action.action.input.extension
                                                                                                          Definition

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

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          810. PlanDefinition.action.action.action.input.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

                                                                                                          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

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

                                                                                                          Defines the data that is to be provided as input to the action.

                                                                                                          ShortWhat data is provided
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: pld-0
                                                                                                          TypeDataRequirement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          816. PlanDefinition.action.action.action.input.relatedData
                                                                                                          Definition

                                                                                                          Points to an existing input or output element that provides data to this input.

                                                                                                          ShortWhat data is provided
                                                                                                          Comments

                                                                                                          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
                                                                                                          This element is affected by the following invariants: pld-0
                                                                                                          Typeid
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          818. PlanDefinition.action.action.action.output
                                                                                                          Definition

                                                                                                          Defines the outputs of the action, if any.

                                                                                                          ShortOutput data definition
                                                                                                          Control0..*
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          pld-1: Output data element must have a requirement or a relatedData, but not both (requirement.exists() xor relatedData.exists())
                                                                                                          820. PlanDefinition.action.action.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.

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          822. PlanDefinition.action.action.action.output.extension
                                                                                                          Definition

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

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          824. PlanDefinition.action.action.action.output.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          826. PlanDefinition.action.action.action.output.title
                                                                                                          Definition

                                                                                                          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

                                                                                                          ShortUser-visible title
                                                                                                          Control0..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          828. PlanDefinition.action.action.action.output.requirement
                                                                                                          Definition

                                                                                                          Defines the data that results as output from the action.

                                                                                                          ShortWhat data is provided
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: pld-1
                                                                                                          TypeDataRequirement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          830. PlanDefinition.action.action.action.output.relatedData
                                                                                                          Definition

                                                                                                          Points to an existing input or output element that is results as output from the action.

                                                                                                          ShortWhat data is provided
                                                                                                          Comments

                                                                                                          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
                                                                                                          This element is affected by the following invariants: pld-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          832. PlanDefinition.action.action.action.relatedAction
                                                                                                          Definition

                                                                                                          A relationship to another action such as "before" or "30-60 minutes after start of".

                                                                                                          ShortRelationship to another action
                                                                                                          Comments

                                                                                                          When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

                                                                                                          Control0..*
                                                                                                          This element is affected by the following invariants: pld-4
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          834. PlanDefinition.action.action.action.relatedAction.id
                                                                                                          Definition

                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          836. PlanDefinition.action.action.action.relatedAction.extension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          838. PlanDefinition.action.action.action.relatedAction.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          840. PlanDefinition.action.action.action.relatedAction.targetId
                                                                                                          Definition

                                                                                                          The element id of the target related action.

                                                                                                          ShortWhat action is this related to
                                                                                                          Control1..1
                                                                                                          This element is affected by the following invariants: pld-4
                                                                                                          Typeid
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          842. PlanDefinition.action.action.action.relatedAction.relationship
                                                                                                          Definition

                                                                                                          The relationship of the start of this action to the related action.

                                                                                                          Shortbefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
                                                                                                          Control1..1
                                                                                                          BindingThe codes SHALL be taken from ActionRelationshipType
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0)

                                                                                                          Defines the types of relationships between actions.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          844. PlanDefinition.action.action.action.relatedAction.endRelationship
                                                                                                          Definition

                                                                                                          The relationship of the end of this action to the related action.

                                                                                                          Shortbefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionRelationshipType
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0)

                                                                                                          Defines the types of relationships between actions.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          846. PlanDefinition.action.action.action.relatedAction.offset[x]
                                                                                                          Definition

                                                                                                          A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

                                                                                                          ShortTime offset for the relationship
                                                                                                          Control0..1
                                                                                                          TypeChoice of: Duration, Range
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          848. PlanDefinition.action.action.action.timing[x]
                                                                                                          Definition

                                                                                                          An optional value describing when the action should be performed.

                                                                                                          ShortWhen the action should take place
                                                                                                          Comments

                                                                                                          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
                                                                                                          TypeChoice of: Age, Duration, Range, Timing
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Requirements

                                                                                                          Allows prompting for activities and detection of missed planned activities.

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          850. PlanDefinition.action.action.action.location
                                                                                                          Definition

                                                                                                          Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

                                                                                                          ShortWhere it should happen
                                                                                                          Comments

                                                                                                          May reference a specific clinical location or may just identify a type of location.

                                                                                                          Control0..1
                                                                                                          TypeCodeableReference(Location)
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Requirements

                                                                                                          Helps in planning of activity.

                                                                                                          Alternate Namesfacility
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          852. PlanDefinition.action.action.action.participant
                                                                                                          Definition

                                                                                                          Indicates who should participate in performing the action described.

                                                                                                          ShortWho should participate in the action
                                                                                                          Control0..*
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          854. PlanDefinition.action.action.action.participant.id
                                                                                                          Definition

                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          856. PlanDefinition.action.action.action.participant.extension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          858. PlanDefinition.action.action.action.participant.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          860. PlanDefinition.action.action.action.participant.actorId
                                                                                                          Definition

                                                                                                          A reference to the id element of the actor who will participate in this action.

                                                                                                          ShortWhat actor
                                                                                                          Control0..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          862. PlanDefinition.action.action.action.participant.type
                                                                                                          Definition

                                                                                                          The type of participant in the action.

                                                                                                          Shortcareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionParticipantType
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0)

                                                                                                          The type of participant in the activity.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          864. PlanDefinition.action.action.action.participant.typeCanonical
                                                                                                          Definition

                                                                                                          The type of participant in the action.

                                                                                                          ShortWho or what can participate
                                                                                                          Control0..1
                                                                                                          Typecanonical(CapabilityStatement)
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          866. PlanDefinition.action.action.action.participant.typeReference
                                                                                                          Definition

                                                                                                          The type of participant in the action.

                                                                                                          ShortWho or what can participate
                                                                                                          Comments

                                                                                                          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
                                                                                                          TypeReference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          868. PlanDefinition.action.action.action.participant.role
                                                                                                          Definition

                                                                                                          The role the participant should play in performing the described action.

                                                                                                          ShortE.g. Nurse, Surgeon, Parent
                                                                                                          Control0..1
                                                                                                          BindingFor example codes, see Action Participant Role
                                                                                                          (example to http://terminology.hl7.org/ValueSet/action-participant-role)

                                                                                                          Defines roles played by participants for the action.

                                                                                                          TypeCodeableConcept
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          870. PlanDefinition.action.action.action.participant.function
                                                                                                          Definition

                                                                                                          Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

                                                                                                          ShortE.g. Author, Reviewer, Witness, etc
                                                                                                          Control0..1
                                                                                                          BindingFor example codes, see ActionParticipantFunction
                                                                                                          (example to http://hl7.org/fhir/ValueSet/action-participant-function)
                                                                                                          TypeCodeableConcept
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          872. PlanDefinition.action.action.action.type
                                                                                                          Definition

                                                                                                          The type of action to perform (create, update, remove).

                                                                                                          Shortcreate | update | remove | fire-event
                                                                                                          Control0..1
                                                                                                          BindingUnless not suitable, these codes SHALL be taken from ActionType
                                                                                                          (extensible to http://hl7.org/fhir/ValueSet/action-type)

                                                                                                          The type of action to be performed.

                                                                                                          TypeCodeableConcept
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          874. PlanDefinition.action.action.action.groupingBehavior
                                                                                                          Definition

                                                                                                          Defines the grouping behavior for the action and its children.

                                                                                                          Shortvisual-group | logical-group | sentence-group
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionGroupingBehavior
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0)

                                                                                                          Defines organization behavior of a group.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          876. PlanDefinition.action.action.action.selectionBehavior
                                                                                                          Definition

                                                                                                          Defines the selection behavior for the action and its children.

                                                                                                          Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionSelectionBehavior
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0)

                                                                                                          Defines selection behavior of a group.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          878. PlanDefinition.action.action.action.requiredBehavior
                                                                                                          Definition

                                                                                                          Defines the required behavior for the action.

                                                                                                          Shortmust | could | must-unless-documented
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionRequiredBehavior
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0)

                                                                                                          Defines expectations around whether an action or action group is required.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Meaning if MissingIf no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          880. PlanDefinition.action.action.action.precheckBehavior
                                                                                                          Definition

                                                                                                          Defines whether the action should usually be preselected.

                                                                                                          Shortyes | no
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionPrecheckBehavior
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0)

                                                                                                          Defines selection frequency behavior for an action or group.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Meaning if MissingIf no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          882. PlanDefinition.action.action.action.cardinalityBehavior
                                                                                                          Definition

                                                                                                          Defines whether the action can be selected multiple times.

                                                                                                          Shortsingle | multiple
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHALL be taken from ActionCardinalityBehavior
                                                                                                          (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0)

                                                                                                          Defines behavior for an action or a group for how many times that item may be repeated.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Meaning if MissingIf no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          884. PlanDefinition.action.action.action.definition[x]
                                                                                                          Definition

                                                                                                          A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

                                                                                                          ShortDescription of the activity to be performed
                                                                                                          Comments

                                                                                                          Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.

                                                                                                          Control0..1
                                                                                                          TypeChoice of: canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          886. PlanDefinition.action.action.action.transform
                                                                                                          Definition

                                                                                                          A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

                                                                                                          ShortTransform to apply the template
                                                                                                          Comments

                                                                                                          Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                                                                          Control0..1
                                                                                                          Typecanonical(StructureMap)
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          888. PlanDefinition.action.action.action.dynamicValue
                                                                                                          Definition

                                                                                                          Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

                                                                                                          ShortDynamic aspects of the definition
                                                                                                          Comments

                                                                                                          Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                                                                          Control0..*
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          890. PlanDefinition.action.action.action.dynamicValue.id
                                                                                                          Definition

                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          892. PlanDefinition.action.action.action.dynamicValue.extension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          894. PlanDefinition.action.action.action.dynamicValue.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          896. PlanDefinition.action.action.action.dynamicValue.path
                                                                                                          Definition

                                                                                                          The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                                                                          ShortThe path to the element to be set dynamically
                                                                                                          Comments

                                                                                                          To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                                                                                                          Control0..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          898. PlanDefinition.action.action.action.dynamicValue.expression
                                                                                                          Definition

                                                                                                          An expression specifying the value of the customized element.

                                                                                                          ShortAn expression that provides the dynamic value for the customization
                                                                                                          Comments

                                                                                                          The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

                                                                                                          Control0..1
                                                                                                          TypeExpression
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          900. PlanDefinition.action.action.action.action
                                                                                                          Definition

                                                                                                          Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

                                                                                                          ShortA sub-action
                                                                                                          Control0..*
                                                                                                          TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          902. PlanDefinition.asNeeded[x]
                                                                                                          Definition

                                                                                                          If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

                                                                                                          ShortPreconditions for service
                                                                                                          Control0..1
                                                                                                          BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodes
                                                                                                          (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)

                                                                                                          A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

                                                                                                          TypeChoice of: boolean, CodeableConcept
                                                                                                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supportfalse
                                                                                                          Summarytrue
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))