12.19 12.22 Resource PlanDefinition - Content

<PlanDefinition xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->

 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <

 <name value="[string]"/><!--  0..1 Name for this plan definition (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <</type>

 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <
 <
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>

 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <
 <
 <
 <
 <</effectivePeriod>
 <</useContext>

 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <</topic>
 <</contributor>
 <</contact>

 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the plan -->

 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <</relatedArtifact>
 <</library>

 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>

 <goal>  <!-- 0..* What the plan is trying to accomplish -->
  <</category>

  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>

  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <</measure>
   <</detail[x]>

   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept The target value to be achieved --></detail[x]>

   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <
  <

 <action>  <!-- 0..* Action defined by the plan -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->

  <title value="[string]"/><!-- 0..1 User-visible title -->
  <
  <
  <</code>

  <description value="[string]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>

  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- 0..* What goals this action supports -->
  <</triggerDefinition>
  <

  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->

   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <
   <
   <

   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>

  </condition>
  <input><!-- 0..* DataRequirement Input data requirements --></input>
  <output><!-- 0..* DataRequirement Output data definition --></output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <</timing[x]>

  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>

  <participant>  <!-- 0..* Who should participate in the action -->
   <
   <</role>

   <type value="[code]"/><!-- 1..1 patient | practitioner | related-person | device -->
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent --></role>

  </participant>
  <</type>

  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>

  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <

  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->

  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <</definition>
  <</transform>

  <definition[x]><!-- 0..1 canonical(ActivityDefinition|PlanDefinition|
    Questionnaire)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>

  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <
   <
   <
   <

   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>

  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
</PlanDefinition>

{
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)

  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  "

  "name" : "<string>", // C? Name for this plan definition (computer friendly)

  "title" : "<string>", // Name for this plan definition (human friendly)
  "

  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition

  "status" : "<code>", // R!  draft | active | retired | unknown
  "
  "
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher

  "description" : "<markdown>", // Natural language description of the plan definition
  "
  "
  "
  "
  "
  "

  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "
  "
  "

  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<string>", // Describes the clinical usage of the plan

  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "
  "

  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : [{ canonical(Library) }], // Logic used by the plan definition

  "goal" : [{ // What the plan is trying to accomplish
    "

    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral

    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "

      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked

      // detail[x]: The target value to be achieved. One of these 3:
      " },
      " },
      " },

      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },

      "due" : { Duration } // Reach goal within
    }]
  }],
  "
    "

  "action" : [{ // Action defined by the plan
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)

    "title" : "<string>", // User-visible title
    "
    "
    "

    "description" : "<string>", // Brief description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions

    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // What goals this action supports
    "
    "

    // subject[x]: Type of individual the action is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable

      "kind" : "<code>", // R!  applicability | start | stop
      "
      "
      "

      "expression" : { Expression } // Boolean-valued expression

    }],
    "input" : [{ DataRequirement }], // Input data requirements
    "output" : [{ DataRequirement }], // Output data definition
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action is this related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    

    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },

    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ // Who should participate in the action
      "
      "

      "type" : "<code>", // R!  patient | practitioner | related-person | device
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent

    }],
    "

    "type" : { CodeableConcept }, // create | update | remove | fire-event

    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "

    "requiredBehavior" : "<code>", // must | could | must-unless-documented

    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "
    "

    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : { canonical(ActivityDefinition|PlanDefinition|
    Questionnaire) },
    "definitionUri" : "<uri>",
    "transform" : { canonical(StructureMap) }, // Transform to apply the template

    "dynamicValue" : [{ // Dynamic aspects of the definition
      "
      "
      "
      "

      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization

    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }]
}

@prefix fhir: <http://hl7.org/fhir/> .
[ a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:PlanDefinition.url [ uri ]; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)

  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the plan definition
  fhir:PlanDefinition.version [ string ]; # 0..1 Business version of the plan definition
  fhir:PlanDefinition.name [ string ]; # 0..1 Name for this plan definition (computer friendly)
  fhir:PlanDefinition.title [ string ]; # 0..1 Name for this plan definition (human friendly)
  fhir:

  fhir:PlanDefinition.subtitle [ string ]; # 0..1 Subordinate title of the plan definition
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition

  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:
  fhir:
  fhir:

  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # PlanDefinition.subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 2
    fhir:PlanDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:PlanDefinition.subjectReference [ Reference(Group) ]
  fhir:PlanDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher

  fhir:PlanDefinition.description [ markdown ]; # 0..1 Natural language description of the plan definition
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:PlanDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support

  fhir:PlanDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:
  fhir:
  fhir:

  fhir:PlanDefinition.purpose [ markdown ]; # 0..1 Why this plan definition is defined
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the plan

  fhir:PlanDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:
  fhir:

  fhir:PlanDefinition.approvalDate [ date ]; # 0..1 When the plan definition was approved by publisher
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 When the plan definition was last reviewed
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 When the plan definition is expected to be used
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment
  fhir:PlanDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:PlanDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:PlanDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:PlanDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:PlanDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations
  fhir:PlanDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the plan definition

  fhir:PlanDefinition.goal [ # 0..* What the plan is trying to accomplish
    fhir:

    fhir:PlanDefinition.goal.category [ CodeableConcept ]; # 0..1 E.g. Treatment, dietary, behavioral

    fhir:PlanDefinition.goal.description [ CodeableConcept ]; # 1..1 Code or text describing the goal
    fhir:PlanDefinition.goal.priority [ CodeableConcept ]; # 0..1 high-priority | medium-priority | low-priority
    fhir:PlanDefinition.goal.start [ CodeableConcept ]; # 0..1 When goal pursuit begins
    fhir:PlanDefinition.goal.addresses [ CodeableConcept ], ... ; # 0..* What does the goal address
    fhir:PlanDefinition.goal.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the goal
    fhir:PlanDefinition.goal.target [ # 0..* Target outcome for the goal
      fhir:
      # . One of these 3
        fhir: ]
        fhir: ]
        fhir: ]

      fhir:PlanDefinition.goal.target.measure [ CodeableConcept ]; # 0..1 The parameter whose value is to be tracked
      # PlanDefinition.goal.target.detail[x] : 0..1 The target value to be achieved. One of these 3
        fhir:PlanDefinition.goal.target.detailQuantity [ Quantity ]
        fhir:PlanDefinition.goal.target.detailRange [ Range ]
        fhir:PlanDefinition.goal.target.detailCodeableConcept [ CodeableConcept ]

      fhir:PlanDefinition.goal.target.due [ Duration ]; # 0..1 Reach goal within
    ], ...;
  ], ...;
  fhir:
    fhir:

  fhir:PlanDefinition.action [ # 0..* Action defined by the plan
    fhir:PlanDefinition.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)

    fhir:PlanDefinition.action.title [ string ]; # 0..1 User-visible title
    fhir:
    fhir:
    fhir:

    fhir:PlanDefinition.action.description [ string ]; # 0..1 Brief description of the action
    fhir:PlanDefinition.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:PlanDefinition.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or sub-actions

    fhir:PlanDefinition.action.reason [ CodeableConcept ], ... ; # 0..* Why the action should be performed
    fhir:PlanDefinition.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.action.goalId [ id ], ... ; # 0..* What goals this action supports
    fhir:
    fhir:

    # PlanDefinition.action.subject[x] : 0..1 Type of individual the action is focused on. One of these 2
      fhir:PlanDefinition.action.subjectCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.action.subjectReference [ Reference(Group) ]
    fhir:PlanDefinition.action.trigger [ TriggerDefinition ], ... ; # 0..* When the action should be triggered
    fhir:PlanDefinition.action.condition [ # 0..* Whether or not the action is applicable

      fhir:PlanDefinition.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:
      fhir:
      fhir:

      fhir:PlanDefinition.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression

    ], ...;
    fhir:PlanDefinition.action.input [ DataRequirement ], ... ; # 0..* Input data requirements
    fhir:PlanDefinition.action.output [ DataRequirement ], ... ; # 0..* Output data definition
    fhir:PlanDefinition.action.relatedAction [ # 0..* Relationship to another action
      fhir:PlanDefinition.action.relatedAction.actionId [ id ]; # 1..1 What action is this related to
      fhir:PlanDefinition.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # PlanDefinition.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.action.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # . One of these 5

    # PlanDefinition.action.timing[x] : 0..1 When the action should take place. One of these 6

      fhir:PlanDefinition.action.timingDateTime [ dateTime ]
      fhir:PlanDefinition.action.timingAge [ Age ]

      fhir:PlanDefinition.action.timingPeriod [ Period ]
      fhir:PlanDefinition.action.timingDuration [ Duration ]
      fhir:PlanDefinition.action.timingRange [ Range ]
      fhir:PlanDefinition.action.timingTiming [ Timing ]
    fhir:PlanDefinition.action.participant [ # 0..* Who should participate in the action
      fhir:
      fhir:

      fhir:PlanDefinition.action.participant.type [ code ]; # 1..1 patient | practitioner | related-person | device
      fhir:PlanDefinition.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent

    ], ...;
    fhir:

    fhir:PlanDefinition.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event

    fhir:PlanDefinition.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:

    fhir:PlanDefinition.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented

    fhir:PlanDefinition.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:
    fhir:

    # PlanDefinition.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:PlanDefinition.action.definitionCanonical [ canonical(ActivityDefinition|PlanDefinition|Questionnaire) ]
      fhir:PlanDefinition.action.definitionUri [ uri ]
    fhir:PlanDefinition.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template

    fhir:PlanDefinition.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:
      fhir:
      fhir:
      fhir:

      fhir:PlanDefinition.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization

    ], ...;
    fhir:PlanDefinition.action.action [ See PlanDefinition.action ], ... ; # 0..* A sub-action
  ], ...;
]

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 11 tests of which 6 fail to execute . All tests pass round-trip testing and 5 r3 resources are invalid (0 errors). )

<PlanDefinition xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->

 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <

 <name value="[string]"/><!--  0..1 Name for this plan definition (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <</type>

 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <
 <
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>

 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <
 <
 <
 <
 <</effectivePeriod>
 <</useContext>

 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <</topic>
 <</contributor>
 <</contact>

 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the plan -->

 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <</relatedArtifact>
 <</library>

 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>

 <goal>  <!-- 0..* What the plan is trying to accomplish -->
  <</category>

  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>

  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <</measure>
   <</detail[x]>

   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept The target value to be achieved --></detail[x]>

   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <
  <

 <action>  <!-- 0..* Action defined by the plan -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->

  <title value="[string]"/><!-- 0..1 User-visible title -->
  <
  <
  <</code>

  <description value="[string]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>

  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- 0..* What goals this action supports -->
  <</triggerDefinition>
  <

  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->

   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <
   <
   <

   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>

  </condition>
  <input><!-- 0..* DataRequirement Input data requirements --></input>
  <output><!-- 0..* DataRequirement Output data definition --></output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <</timing[x]>

  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>

  <participant>  <!-- 0..* Who should participate in the action -->
   <
   <</role>

   <type value="[code]"/><!-- 1..1 patient | practitioner | related-person | device -->
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent --></role>

  </participant>
  <</type>

  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>

  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <

  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->

  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <</definition>
  <</transform>

  <definition[x]><!-- 0..1 canonical(ActivityDefinition|PlanDefinition|
    Questionnaire)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>

  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <
   <
   <
   <

   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>

  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
</PlanDefinition>

{
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)

  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  "

  "name" : "<string>", // C? Name for this plan definition (computer friendly)

  "title" : "<string>", // Name for this plan definition (human friendly)
  "

  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition

  "status" : "<code>", // R!  draft | active | retired | unknown
  "
  "
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher

  "description" : "<markdown>", // Natural language description of the plan definition
  "
  "
  "
  "
  "
  "

  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "
  "
  "

  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<string>", // Describes the clinical usage of the plan

  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "
  "

  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : [{ canonical(Library) }], // Logic used by the plan definition

  "goal" : [{ // What the plan is trying to accomplish
    "

    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral

    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "

      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked

      // detail[x]: The target value to be achieved. One of these 3:
      " },
      " },
      " },

      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },

      "due" : { Duration } // Reach goal within
    }]
  }],
  "
    "

  "action" : [{ // Action defined by the plan
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)

    "title" : "<string>", // User-visible title
    "
    "
    "

    "description" : "<string>", // Brief description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions

    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // What goals this action supports
    "
    "

    // subject[x]: Type of individual the action is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable

      "kind" : "<code>", // R!  applicability | start | stop
      "
      "
      "

      "expression" : { Expression } // Boolean-valued expression

    }],
    "input" : [{ DataRequirement }], // Input data requirements
    "output" : [{ DataRequirement }], // Output data definition
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action is this related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    

    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },

    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ // Who should participate in the action
      "
      "

      "type" : "<code>", // R!  patient | practitioner | related-person | device
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent

    }],
    "

    "type" : { CodeableConcept }, // create | update | remove | fire-event

    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "

    "requiredBehavior" : "<code>", // must | could | must-unless-documented

    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "
    "

    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : { canonical(ActivityDefinition|PlanDefinition|
    Questionnaire) },
    "definitionUri" : "<uri>",
    "transform" : { canonical(StructureMap) }, // Transform to apply the template

    "dynamicValue" : [{ // Dynamic aspects of the definition
      "
      "
      "
      "

      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization

    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }]
}