description: Base StructureDefinition for PlanDefinition Resource package_name: hl7.fhir.core derivation: specialization name: PlanDefinition type: PlanDefinition elements: description: {type: markdown, short: Natural language description of the plan definition, comments: 'This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.', index: 9} date: {short: Date this was last changed, comments: 'Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions.', type: dateTime, isSummary: true, index: 8} publisher: {short: Name of the publisher (Organization or individual), comments: 'Usually an organization, but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.', type: string, isSummary: true, index: 19} approvalDate: {short: When plan definition approved by publisher, comments: The date may be more recent than the approval date because of minor changes / editorial corrections., type: date, index: 12} jurisdiction: {short: Intended jurisdiction for plan definition (if applicable), type: CodeableConcept, array: true, isSummary: true, index: 16} purpose: {short: Why this plan definition is defined, comments: 'This element does not describe the usage of the plan definition (See, e.g, the comments element, or relatedArtifacts), rather it''s for traceability of ''''why'''' the resource is either needed or ''''why'''' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.', type: markdown, index: 10} name: {short: Name for this plan definition (Computer friendly), comments: The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly., type: string, isSummary: true, index: 3} useContext: {short: Content intends to support these contexts, comments: 'When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.', type: UsageContext, array: true, isSummary: true, index: 15} 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: 'If for testing purposes, not real usage', comments: Allows filtering of plan definition that are appropriate for use vs. not., type: boolean, isSummary: true, index: 7} topic: {type: CodeableConcept, short: Descriptional topics for the asset, array: true, index: 17} title: {type: string, short: Name for this plan definition (Human friendly), 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: 11} contributor: {type: Contributor, short: A content contributor, array: true, index: 18} status: {isModifier: true, short: draft | active | retired, comments: Allows filtering of plan definition that are appropriate for use vs. not., type: code, isSummary: true, index: 6} url: {short: Logical uri to reference this plan definition (globally unique), comments: 'Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.', type: uri, isSummary: true, index: 0} identifier: {short: Additional identifier for the plan definition, comments: 'Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this plan definition outside of FHIR, where the logical URL is not possible to use.', type: Identifier, array: true, isSummary: true, index: 1} lastReviewDate: {short: Last review date for the plan definition, comments: 'If specified, this is usually after the approval date.', type: date, index: 13} actionDefinition: type: BackboneElement short: Action defined by the plan array: true index: 24 elements: timingRange: {type: Range, short: When the action should take place, choiceOf: timing, index: 52} description: {type: string, short: Short description of the action, index: 28} triggerDefinition: {type: TriggerDefinition, short: When the action should be triggered, array: true, index: 32} transform: type: Reference short: Transform to apply the template refers: ['http://hl7.org/fhir/StructureDefinition/StructureMap'] index: 62 textEquivalent: {type: string, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', index: 29} timingPeriod: {type: Period, short: When the action should take place, choiceOf: timing, index: 50} relatedAction: type: BackboneElement short: Relationship to another action comments: When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency. array: true index: 40 elements: actionIdentifier: {type: Identifier, short: Identifier of the related action, index: 41} relationship: {type: code, short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end, index: 42} offset: short: Time offset for the relationship choices: [offsetDuration, offsetRange] index: 44 offsetDuration: {type: Duration, short: Time offset for the relationship, choiceOf: offset, index: 45} offsetRange: {type: Range, short: Time offset for the relationship, choiceOf: offset, index: 46} required: [actionIdentifier, relationship] type: {type: Coding, short: create | update | remove | fire-event, index: 55} output: {type: DataRequirement, short: Output data definition, array: true, index: 39} title: {type: string, short: User-visible title, index: 27} documentation: {type: RelatedArtifact, short: Supporting documentation for the intended performer of the action, array: true, index: 31} selectionBehavior: {type: code, short: any | all | all-or-none | exactly-one | at-most-one | one-or-more, index: 57} timingDateTime: {type: dateTime, short: When the action should take place, choiceOf: timing, index: 49} timingTiming: {type: Timing, short: When the action should take place, choiceOf: timing, index: 53} participantType: {type: code, short: patient | practitioner | related-person, array: true, index: 54} timingDuration: {type: Duration, short: When the action should take place, choiceOf: timing, index: 51} requiredBehavior: {type: code, short: must | could | must-unless-documented, index: 58} label: {type: string, short: User-visible label for the action (e.g. 1. or A.), index: 26} condition: type: BackboneElement short: Whether or not the action is applicable array: true index: 33 elements: kind: {short: applicability | start | stop, comments: Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when enter/exit criteria for an action., type: code, index: 34} description: {type: string, short: Natural language description of the condition, index: 35} language: {type: string, short: Language of the expression, index: 36} expression: {type: string, short: Boolean-valued expression, comments: 'The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.', index: 37} required: [kind] timing: short: When the action should take place choices: [timingDateTime, timingPeriod, timingDuration, timingRange, timingTiming] index: 48 groupingBehavior: {type: code, short: visual-group | logical-group | sentence-group, index: 56} activityDefinition: short: Description of the activity to be performed refers: ['http://hl7.org/fhir/StructureDefinition/ActivityDefinition'] comments: Note that the resource is optional, and if no resource is specified, a dynamicValue with a root (/) path can be used to define the entire resource dynamically. type: Reference index: 61 dynamicValue: type: BackboneElement short: Dynamic aspects of the definition array: true index: 63 elements: description: {type: string, short: Natural language description of the dynamic value, index: 64} path: {type: string, short: The path to the element to be set dynamically, index: 65} language: {type: string, short: Language of the expression, index: 66} expression: {type: string, short: An expression that provides the dynamic value for the customization, comments: 'The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.', index: 67} code: {type: CodeableConcept, short: The meaning of the action or its sub-actions, array: true, index: 30} precheckBehavior: {type: code, short: yes | no, index: 59} actionDefinition: short: A sub-action elementReference: ['http://hl7.org/fhir/StructureDefinition/PlanDefinition', elements, actionDefinition] array: true index: 68 input: {type: DataRequirement, short: Input data requirements, array: true, index: 38} actionIdentifier: {type: Identifier, short: Unique identifier, index: 25} cardinalityBehavior: {type: code, short: single | multiple, index: 60} version: {short: Business version of the plan definition, comments: There may be multiple different instances of a plan definition that have the same identifier but different versions., type: string, isSummary: true, index: 2} relatedArtifact: {short: Related artifacts for the asset, comments: 'Each related artifact is either an attachment, or a reference to another resource, but not both.', type: RelatedArtifact, array: true, index: 22} contact: {short: Contact details for the publisher, comments: 'May be a web site, an email address, a telephone number, etc.', type: ContactDetail, array: true, isSummary: true, index: 20} effectivePeriod: {short: The effective date range for the plan definition, comments: 'The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.', type: Period, isSummary: true, index: 14} package_version: 1.8.0 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/PlanDefinition base: http://hl7.org/fhir/StructureDefinition/DomainResource version: null required: [status]