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.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: PlanDefinition
type: PlanDefinition
elements:
  description: {short: Natural language description of the plan definition, type: markdown, isSummary: true, index: 16}
  date: {short: Date last changed, type: dateTime, isSummary: true, index: 13}
  endorser: {type: ContactDetail, short: Who endorsed the content, array: true, index: 29}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 14}
  approvalDate: {short: When the plan definition was approved by publisher, type: date, index: 22}
  jurisdiction:
    short: Intended jurisdiction for plan definition (if applicable)
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 18
  purpose: {short: Why this plan definition is defined, type: markdown, index: 19}
  subjectCodeableConcept: {short: Type of individual the plan definition is focused on, type: CodeableConcept, meaningWhenMissing: Patient, choiceOf: subject, index: 11}
  name: {short: Name for this plan definition (computer friendly), type: string, isSummary: true, index: 3}
  useContext: {short: The context that the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 17}
  goal:
    type: BackboneElement
    short: What the plan is trying to accomplish
    array: true
    index: 32
    elements:
      category:
        type: CodeableConcept
        short: E.g. Treatment, dietary, behavioral
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/goal-category'}
        index: 33
      description:
        short: Code or text describing the goal
        type: CodeableConcept
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/clinical-findings'}
        index: 34
      priority:
        type: CodeableConcept
        short: high-priority | medium-priority | low-priority
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/goal-priority'}
        index: 35
      start:
        type: CodeableConcept
        short: When goal pursuit begins
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/goal-start-event'}
        index: 36
      addresses:
        type: CodeableConcept
        short: What does the goal address
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/condition-code'}
        array: true
        index: 37
      documentation: {type: RelatedArtifact, short: Supporting documentation for the goal, array: true, index: 38}
      target:
        type: BackboneElement
        short: Target outcome for the goal
        array: true
        index: 39
        elements:
          measure:
            type: CodeableConcept
            short: The parameter whose value is to be tracked
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-codes'}
            index: 40
          detail:
            short: The target value to be achieved
            choices: [detailQuantity, detailRange, detailCodeableConcept]
            index: 42
          detailQuantity: {type: Quantity, short: The target value to be achieved, choiceOf: detail, index: 43}
          detailRange: {type: Range, short: The target value to be achieved, choiceOf: detail, index: 44}
          detailCodeableConcept: {type: CodeableConcept, short: The target value to be achieved, choiceOf: detail, index: 45}
          due: {type: Duration, short: Reach goal within, index: 46}
    required: [description]
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 21}
  type:
    short: order-set | clinical-protocol | eca-rule | workflow-definition
    type: CodeableConcept
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/plan-definition-type'}
    isSummary: true
    index: 6
  experimental: {short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 8}
  topic:
    short: E.g. Education, Treatment, Assessment
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    index: 25
  title: {short: Name for this plan definition (human friendly), type: string, isSummary: true, index: 4}
  library: {type: canonical, short: Logic used by the plan definition, array: true, index: 31}
  author: {type: ContactDetail, short: Who authored the content, array: true, index: 26}
  usage: {type: string, short: Describes the clinical usage of the plan, index: 20}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.5.0'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 7
  subtitle: {type: string, short: Subordinate title of the plan definition, index: 5}
  url: {short: 'Canonical identifier for this plan definition, represented as a URI (globally unique)', type: uri, isSummary: true, index: 0}
  identifier: {short: Additional identifier for the plan definition, type: Identifier, array: true, isSummary: true, index: 1}
  lastReviewDate: {short: When the plan definition was last reviewed, type: date, index: 23}
  editor: {type: ContactDetail, short: Who edited the content, array: true, index: 27}
  action:
    short: Action defined by the plan
    type: BackboneElement
    array: true
    index: 47
    elements:
      timingRange: {type: Range, short: When the action should take place, choiceOf: timing, index: 80}
      description: {type: string, short: Brief description of the action, index: 50}
      definition:
        short: Description of the activity to be performed
        choices: [definitionCanonical, definitionUri]
        index: 92
      transform: {type: canonical, short: Transform to apply the template, index: 95}
      textEquivalent: {type: string, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', index: 51}
      definitionUri: {short: Description of the activity to be performed, type: uri, choiceOf: definition, index: 94}
      goalId: {type: id, short: What goals this action supports, array: true, index: 56}
      subjectCodeableConcept: {short: Type of individual the action is focused on, type: CodeableConcept, meaningWhenMissing: Patient, choiceOf: subject, index: 59}
      timingPeriod: {type: Period, short: When the action should take place, choiceOf: timing, index: 78}
      definitionCanonical: {short: Description of the activity to be performed, type: canonical, choiceOf: definition, index: 93}
      relatedAction:
        type: BackboneElement
        short: Relationship to another action
        array: true
        index: 67
        elements:
          actionId: {type: id, short: What action is this related to, index: 68}
          relationship:
            type: code
            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.5.0'}
            index: 69
          offset:
            short: Time offset for the relationship
            choices: [offsetDuration, offsetRange]
            index: 71
          offsetDuration: {type: Duration, short: Time offset for the relationship, choiceOf: offset, index: 72}
          offsetRange: {type: Range, short: Time offset for the relationship, choiceOf: offset, index: 73}
        required: [relationship, actionId]
      type:
        type: CodeableConcept
        short: create | update | remove | fire-event
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/action-type'}
        index: 85
      participant:
        type: BackboneElement
        short: Who should participate in the action
        array: true
        index: 82
        elements:
          type:
            type: code
            short: patient | practitioner | related-person | device
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-type|4.5.0'}
            index: 83
          role:
            type: CodeableConcept
            short: E.g. Nurse, Surgeon, Parent
            binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/action-participant-role'}
            index: 84
        required: [type]
      output: {type: DataRequirement, short: Output data definition, array: true, index: 66}
      title: {type: string, short: User-visible title, index: 49}
      documentation: {type: RelatedArtifact, short: Supporting documentation for the intended performer of the action, array: true, index: 55}
      prefix: {type: string, short: User-visible prefix for the action (e.g. 1. or A.), index: 48}
      selectionBehavior:
        type: code
        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.5.0'}
        index: 87
      reason: {type: CodeableConcept, short: Why the action should be performed, array: true, index: 54}
      timingDateTime: {type: dateTime, short: When the action should take place, choiceOf: timing, index: 76}
      timingTiming: {type: Timing, short: When the action should take place, choiceOf: timing, index: 81}
      timingDuration: {type: Duration, short: When the action should take place, choiceOf: timing, index: 79}
      priority:
        type: code
        short: routine | urgent | asap | stat
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.5.0'}
        index: 52
      requiredBehavior:
        type: code
        short: must | could | must-unless-documented
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-required-behavior|4.5.0'}
        index: 88
      condition:
        type: BackboneElement
        short: Whether or not the action is applicable
        array: true
        index: 62
        elements:
          kind:
            short: applicability | start | stop
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-condition-kind|4.5.0'}
            index: 63
          expression: {type: Expression, short: Boolean-valued expression, index: 64}
        required: [kind]
      timing:
        short: When the action should take place
        choices: [timingDateTime, timingAge, timingPeriod, timingDuration, timingRange, timingTiming]
        index: 75
      groupingBehavior:
        type: code
        short: visual-group | logical-group | sentence-group
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.5.0'}
        index: 86
      dynamicValue:
        type: BackboneElement
        short: Dynamic aspects of the definition
        array: true
        index: 96
        elements:
          path: {type: string, short: The path to the element to be set dynamically, index: 97}
          expression: {type: Expression, short: An expression that provides the dynamic value for the customization, index: 98}
      code: {type: CodeableConcept, short: Code representing the meaning of the action or sub-actions, array: true, index: 53}
      timingAge: {type: Age, short: When the action should take place, choiceOf: timing, index: 77}
      action:
        short: A sub-action
        elementReference: ['http://hl7.org/fhir/StructureDefinition/PlanDefinition', elements, action]
        array: true
        index: 99
      precheckBehavior:
        type: code
        short: yes | no
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.5.0'}
        index: 89
      input: {type: DataRequirement, short: Input data requirements, array: true, index: 65}
      trigger: {type: TriggerDefinition, short: When the action should be triggered, array: true, index: 61}
      subjectReference:
        short: Type of individual the action is focused on
        refers: ['http://hl7.org/fhir/StructureDefinition/Group']
        type: Reference
        meaningWhenMissing: Patient
        choiceOf: subject
        index: 60
      subject:
        short: Type of individual the action is focused on
        choices: [subjectCodeableConcept, subjectReference]
        meaningWhenMissing: Patient
        index: 58
      cardinalityBehavior:
        type: code
        short: single | multiple
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.5.0'}
        index: 90
  reviewer: {type: ContactDetail, short: Who reviewed the content, array: true, index: 28}
  version: {short: Business version of the plan definition, type: string, isSummary: true, index: 2}
  relatedArtifact: {short: 'Additional documentation, citations', type: RelatedArtifact, array: true, index: 30}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 15}
  subjectReference:
    short: Type of individual the plan definition is focused on
    refers: ['http://hl7.org/fhir/StructureDefinition/Group']
    type: Reference
    meaningWhenMissing: Patient
    choiceOf: subject
    index: 12
  subject:
    short: Type of individual the plan definition is focused on
    choices: [subjectCodeableConcept, subjectReference]
    meaningWhenMissing: Patient
    index: 10
  effectivePeriod: {short: When the plan definition is expected to be used, type: Period, isSummary: true, index: 24}
package_version: 4.5.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/PlanDefinition
base: http://hl7.org/fhir/StructureDefinition/MetadataResource
version: 4.5.0
required: [status]