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