http://hl7.org/fhir/StructureDefinition/PlanDefinition|4.0.1

description: This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
derivation: specialization
name: PlanDefinition
type: PlanDefinition
elements:
  description: {short: Natural language description of the plan definition, isSummary: true, index: 14}
  date: {short: Date last changed, isSummary: true, index: 11}
  endorser: {short: Who endorsed the content, array: true, index: 27}
  publisher: {short: Name of the publisher (organization or individual), isSummary: true, index: 12}
  approvalDate: {short: When the plan definition was approved by publisher, index: 20}
  jurisdiction:
    short: Intended jurisdiction for plan definition (if applicable)
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 16
  purpose: {short: Why this plan definition is defined, index: 17}
  name: {short: Name for this plan definition (computer friendly), isSummary: true, index: 3}
  useContext: {short: The context that the content is intended to support, array: true, isSummary: true, index: 15}
  goal:
    short: What the plan is trying to accomplish
    array: true
    index: 30
    elements:
      category:
        short: E.g. Treatment, dietary, behavioral
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/goal-category'}
        index: 31
      description:
        short: Code or text describing the goal
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/clinical-findings'}
        index: 32
      priority:
        short: high-priority | medium-priority | low-priority
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/goal-priority'}
        index: 33
      start:
        short: When goal pursuit begins
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/goal-start-event'}
        index: 34
      addresses:
        short: What does the goal address
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/condition-code'}
        index: 35
      documentation: {short: Supporting documentation for the goal, array: true, index: 36}
      target:
        short: Target outcome for the goal
        array: true
        index: 37
        elements:
          measure:
            short: The parameter whose value is to be tracked
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-codes'}
            index: 38
          detail:
            short: The target value to be achieved
            choices: []
            index: 40
          due: {short: Reach goal within, index: 41}
    required: [description]
  copyright: {short: Use and/or publishing restrictions, index: 19}
  type:
    short: order-set | clinical-protocol | eca-rule | workflow-definition
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/plan-definition-type'}
    isSummary: true
    index: 6
  experimental: {short: 'For testing purposes, not real usage', isSummary: true, index: 8}
  topic:
    short: E.g. Education, Treatment, Assessment
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    index: 23
  title: {short: Name for this plan definition (human friendly), isSummary: true, index: 4}
  library: {short: Logic used by the plan definition, array: true, index: 29}
  author: {short: Who authored the content, array: true, index: 24}
  usage: {short: Describes the clinical usage of the plan, index: 18}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.0.1'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 7
  subtitle: {short: Subordinate title of the plan definition, index: 5}
  url: {short: 'Canonical identifier for this plan definition, represented as a URI (globally unique)', isSummary: true, index: 0}
  identifier: {short: Additional identifier for the plan definition, array: true, isSummary: true, index: 1}
  lastReviewDate: {short: When the plan definition was last reviewed, index: 21}
  editor: {short: Who edited the content, array: true, index: 25}
  action:
    short: Action defined by the plan
    array: true
    index: 42
    elements:
      description: {short: Brief description of the action, index: 45}
      definition:
        short: Description of the activity to be performed
        choices: []
        index: 77
      transform: {short: Transform to apply the template, index: 78}
      textEquivalent: {short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', index: 46}
      goalId: {short: What goals this action supports, array: true, index: 51}
      relatedAction:
        short: Relationship to another action
        array: true
        index: 60
        elements:
          actionId: {short: What action is this related to, index: 61}
          relationship:
            short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1'}
            index: 62
          offset:
            short: Time offset for the relationship
            choices: []
            index: 64
        required: [relationship, actionId]
      type:
        short: create | update | remove | fire-event
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/action-type'}
        index: 70
      participant:
        short: Who should participate in the action
        array: true
        index: 67
        elements:
          type:
            short: patient | practitioner | related-person | device
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1'}
            index: 68
          role:
            short: E.g. Nurse, Surgeon, Parent
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-role'}
            index: 69
        required: [type]
      output: {short: Output data definition, array: true, index: 59}
      title: {short: User-visible title, index: 44}
      documentation: {short: Supporting documentation for the intended performer of the action, array: true, index: 50}
      prefix: {short: User-visible prefix for the action (e.g. 1. or A.), index: 43}
      selectionBehavior:
        short: any | all | all-or-none | exactly-one | at-most-one | one-or-more
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1'}
        index: 72
      reason: {short: Why the action should be performed, array: true, index: 49}
      priority:
        short: routine | urgent | asap | stat
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.0.1'}
        index: 47
      requiredBehavior:
        short: must | could | must-unless-documented
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1'}
        index: 73
      condition:
        short: Whether or not the action is applicable
        array: true
        index: 55
        elements:
          kind:
            short: applicability | start | stop
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1'}
            index: 56
          expression: {short: Boolean-valued expression, index: 57}
        required: [kind]
      timing:
        short: When the action should take place
        choices: []
        index: 66
      groupingBehavior:
        short: visual-group | logical-group | sentence-group
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1'}
        index: 71
      dynamicValue:
        short: Dynamic aspects of the definition
        array: true
        index: 79
        elements:
          path: {short: The path to the element to be set dynamically, index: 80}
          expression: {short: An expression that provides the dynamic value for the customization, index: 81}
      code: {short: Code representing the meaning of the action or sub-actions, array: true, index: 48}
      action:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/PlanDefinition', elements, action]
        short: A sub-action
        array: true
        index: 82
      precheckBehavior:
        short: yes | no
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1'}
        index: 74
      input: {short: Input data requirements, array: true, index: 58}
      trigger: {short: When the action should be triggered, array: true, index: 54}
      subject:
        short: Type of individual the action is focused on
        choices: []
        meaningWhenMissing: Patient
        index: 53
      cardinalityBehavior:
        short: single | multiple
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1'}
        index: 75
  reviewer: {short: Who reviewed the content, array: true, index: 26}
  version: {short: Business version of the plan definition, isSummary: true, index: 2}
  relatedArtifact: {short: 'Additional documentation, citations', array: true, index: 28}
  contact: {short: Contact details for the publisher, array: true, isSummary: true, index: 13}
  subject:
    short: Type of individual the plan definition is focused on
    choices: []
    meaningWhenMissing: Patient
    index: 10
  effectivePeriod: {short: When the plan definition is expected to be used, isSummary: true, index: 22}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/PlanDefinition
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [status]