PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r3.examples@3.0.2
    http://hl7.org/fhir/StructureDefinition/PlanDefinition
description: Base StructureDefinition for PlanDefinition Resource
package_name: hl7.fhir.r3.examples
derivation: specialization
name: PlanDefinition
type: PlanDefinition
elements:
  description: {short: Natural language description of the plan definition, type: markdown, isSummary: true, index: 10}
  date: {short: Date this was last changed, type: dateTime, isSummary: true, index: 8}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 9}
  approvalDate: {short: When the plan definition was approved by publisher, type: date, index: 13}
  jurisdiction: {short: Intended jurisdiction for plan definition (if applicable), type: CodeableConcept, array: true, isSummary: true, index: 17}
  purpose: {short: Why this plan definition is defined, type: markdown, index: 11}
  name: {short: Name for this plan definition (computer friendly), type: string, isSummary: true, index: 3}
  useContext: {short: Context the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 16}
  goal:
    type: BackboneElement
    short: What the plan is trying to accomplish
    array: true
    index: 24
    elements:
      category: {type: CodeableConcept, short: 'E.g. Treatment, dietary, behavioral, etc', index: 25}
      description: {short: Code or text describing the goal, type: CodeableConcept, index: 26}
      priority: {type: CodeableConcept, short: high-priority | medium-priority | low-priority, index: 27}
      start: {type: CodeableConcept, short: When goal pursuit begins, index: 28}
      addresses: {type: CodeableConcept, short: What does the goal address, array: true, index: 29}
      documentation: {type: RelatedArtifact, short: Supporting documentation for the goal, array: true, index: 30}
      target:
        type: BackboneElement
        short: Target outcome for the goal
        array: true
        index: 31
        elements:
          measure: {type: CodeableConcept, short: The parameter whose value is to be tracked, index: 32}
          detail:
            short: The target value to be achieved
            choices: [detailQuantity, detailRange, detailCodeableConcept]
            index: 34
          detailQuantity: {type: Quantity, short: The target value to be achieved, choiceOf: detail, index: 35}
          detailRange: {type: Range, short: The target value to be achieved, choiceOf: detail, index: 36}
          detailCodeableConcept: {type: CodeableConcept, short: The target value to be achieved, choiceOf: detail, index: 37}
          due: {type: Duration, short: Reach goal within, index: 38}
    required: [description]
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 21}
  type: {short: order-set | protocol | eca-rule, type: CodeableConcept, isSummary: true, index: 5}
  experimental: {isModifier: true, short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 7}
  topic: {short: 'E.g. Education, Treatment, Assessment, etc', type: CodeableConcept, array: true, index: 18}
  title: {short: Name for this plan definition (human friendly), type: string, isSummary: true, index: 4}
  library:
    type: Reference
    short: Logic used by the plan definition
    refers: ['http://hl7.org/fhir/StructureDefinition/Library']
    array: true
    index: 23
  usage: {type: string, short: Describes the clinical usage of the asset, index: 12}
  contributor: {type: Contributor, short: A content contributor, array: true, index: 19}
  status: {isModifier: true, short: draft | active | retired | unknown, type: code, isSummary: true, index: 6}
  url: {short: Logical URI to reference this plan definition (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: 14}
  action:
    type: BackboneElement
    short: Action defined by the plan
    array: true
    index: 39
    elements:
      timingRange: {type: Range, short: When the action should take place, choiceOf: timing, index: 68}
      description: {type: string, short: Short description of the action, index: 42}
      triggerDefinition: {type: TriggerDefinition, short: When the action should be triggered, array: true, index: 48}
      definition:
        short: Description of the activity to be performed
        refers: ['http://hl7.org/fhir/StructureDefinition/ActivityDefinition', 'http://hl7.org/fhir/StructureDefinition/PlanDefinition']
        type: Reference
        index: 79
      transform:
        type: Reference
        short: Transform to apply the template
        refers: ['http://hl7.org/fhir/StructureDefinition/StructureMap']
        index: 80
      textEquivalent: {type: string, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', index: 43}
      goalId: {type: id, short: What goals this action supports, array: true, index: 47}
      timingPeriod: {type: Period, short: When the action should take place, choiceOf: timing, index: 66}
      relatedAction:
        type: BackboneElement
        short: Relationship to another action
        array: true
        index: 56
        elements:
          actionId: {type: id, short: What action is this related to, index: 57}
          relationship: {type: code, short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end, index: 58}
          offset:
            short: Time offset for the relationship
            choices: [offsetDuration, offsetRange]
            index: 60
          offsetDuration: {type: Duration, short: Time offset for the relationship, choiceOf: offset, index: 61}
          offsetRange: {type: Range, short: Time offset for the relationship, choiceOf: offset, index: 62}
        required: [relationship, actionId]
      type: {type: Coding, short: create | update | remove | fire-event, index: 73}
      participant:
        type: BackboneElement
        short: Who should participate in the action
        array: true
        index: 70
        elements:
          type: {type: code, short: patient | practitioner | related-person, index: 71}
          role: {type: CodeableConcept, short: 'E.g. Nurse, Surgeon, Parent, etc', index: 72}
        required: [type]
      output: {type: DataRequirement, short: Output data definition, array: true, index: 55}
      title: {type: string, short: User-visible title, index: 41}
      documentation: {type: RelatedArtifact, short: Supporting documentation for the intended performer of the action, array: true, index: 46}
      selectionBehavior: {type: code, short: any | all | all-or-none | exactly-one | at-most-one | one-or-more, index: 75}
      reason: {type: CodeableConcept, short: Why the action should be performed, array: true, index: 45}
      timingDateTime: {type: dateTime, short: When the action should take place, choiceOf: timing, index: 65}
      timingTiming: {type: Timing, short: When the action should take place, choiceOf: timing, index: 69}
      timingDuration: {type: Duration, short: When the action should take place, choiceOf: timing, index: 67}
      requiredBehavior: {type: code, short: must | could | must-unless-documented, index: 76}
      label: {type: string, short: User-visible label for the action (e.g. 1. or A.), index: 40}
      condition:
        type: BackboneElement
        short: Whether or not the action is applicable
        array: true
        index: 49
        elements:
          kind: {short: applicability | start | stop, type: code, index: 50}
          description: {type: string, short: Natural language description of the condition, index: 51}
          language: {type: string, short: Language of the expression, index: 52}
          expression: {type: string, short: Boolean-valued expression, index: 53}
        required: [kind]
      timing:
        short: When the action should take place
        choices: [timingDateTime, timingPeriod, timingDuration, timingRange, timingTiming]
        index: 64
      groupingBehavior: {type: code, short: visual-group | logical-group | sentence-group, index: 74}
      dynamicValue:
        type: BackboneElement
        short: Dynamic aspects of the definition
        array: true
        index: 81
        elements:
          description: {type: string, short: Natural language description of the dynamic value, index: 82}
          path: {type: string, short: The path to the element to be set dynamically, index: 83}
          language: {type: string, short: Language of the expression, index: 84}
          expression: {type: string, short: An expression that provides the dynamic value for the customization, index: 85}
      code: {type: CodeableConcept, short: Code representing the meaning of the action or sub-actions, array: true, index: 44}
      action:
        short: A sub-action
        elementReference: ['http://hl7.org/fhir/StructureDefinition/PlanDefinition', elements, action]
        array: true
        index: 86
      precheckBehavior: {type: code, short: yes | no, index: 77}
      input: {type: DataRequirement, short: Input data requirements, array: true, index: 54}
      cardinalityBehavior: {type: code, short: single | multiple, index: 78}
  version: {short: Business version of the plan definition, type: string, isSummary: true, index: 2}
  relatedArtifact: {short: Related artifacts for the asset, type: RelatedArtifact, array: true, index: 22}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 20}
  effectivePeriod: {short: When the plan definition is expected to be used, type: Period, isSummary: true, index: 15}
package_version: 3.0.2
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/PlanDefinition
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status]