Skip to main content

PlanDefinition

PropertyValue
Publisher
NamePlanDefinition
URLhttp://hl7.org/fhir/StructureDefinition/PlanDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
PlanDefinition0..*PlanDefinitionThis 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.
PlanDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PlanDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
PlanDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
PlanDefinition.language0..1codeThe base language in which the resource is written.
PlanDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
PlanDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
PlanDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.url0..1uriAn absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
PlanDefinition.identifier0..*IdentifierA formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
PlanDefinition.version0..1stringThe identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
PlanDefinition.name0..1stringA natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
PlanDefinition.title0..1stringA short, descriptive, user-friendly title for the plan definition.
PlanDefinition.subtitle0..1stringAn explanatory or alternate title for the plan definition giving additional information about its content.
PlanDefinition.type0..1CodeableConceptA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
PlanDefinition.status1..1codeThe status of this plan definition. Enables tracking the life-cycle of the content.
PlanDefinition.experimental0..1booleanA Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
PlanDefinition.subject[x]0..1CodeableConceptA code or group definition that describes the intended subject of the plan definition.
PlanDefinition.date0..1dateTimeThe date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
PlanDefinition.publisher0..1stringThe name of the organization or individual that published the plan definition.
PlanDefinition.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
PlanDefinition.description0..1markdownA free text natural language description of the plan definition from a consumer's perspective.
PlanDefinition.useContext0..*UsageContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
PlanDefinition.jurisdiction0..*CodeableConceptA legal or geographic region in which the plan definition is intended to be used.
PlanDefinition.purpose0..1markdownExplanation of why this plan definition is needed and why it has been designed as it has.
PlanDefinition.usage0..1stringA detailed description of how the plan definition is used from a clinical perspective.
PlanDefinition.copyright0..1markdownA copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
PlanDefinition.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
PlanDefinition.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
PlanDefinition.effectivePeriod0..1PeriodThe period during which the plan definition content was or is planned to be in active use.
PlanDefinition.topic0..*CodeableConceptDescriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
PlanDefinition.author0..*ContactDetailAn individiual or organization primarily involved in the creation and maintenance of the content.
PlanDefinition.editor0..*ContactDetailAn individual or organization primarily responsible for internal coherence of the content.
PlanDefinition.reviewer0..*ContactDetailAn individual or organization primarily responsible for review of some aspect of the content.
PlanDefinition.endorser0..*ContactDetailAn individual or organization responsible for officially endorsing the content for use in some setting.
PlanDefinition.relatedArtifact0..*RelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
PlanDefinition.library0..*canonicalA reference to a Library resource containing any formal logic used by the plan definition.
PlanDefinition.goal0..*BackboneElementGoals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
PlanDefinition.goal.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.goal.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.goal.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.goal.category0..1CodeableConceptIndicates a category the goal falls within.
PlanDefinition.goal.description1..1CodeableConceptHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
PlanDefinition.goal.priority0..1CodeableConceptIdentifies the expected level of importance associated with reaching/sustaining the defined goal.
PlanDefinition.goal.start0..1CodeableConceptThe event after which the goal should begin being pursued.
PlanDefinition.goal.addresses0..*CodeableConceptIdentifies problems, conditions, issues, or concerns the goal is intended to address.
PlanDefinition.goal.documentation0..*RelatedArtifactDidactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
PlanDefinition.goal.target0..*BackboneElementIndicates what should be done and within what timeframe.
PlanDefinition.goal.target.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.goal.target.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.goal.target.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.goal.target.measure0..1CodeableConceptThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
PlanDefinition.goal.target.detail[x]0..1QuantityThe target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
PlanDefinition.goal.target.due0..1DurationIndicates the timeframe after the start of the goal in which the goal should be met.
PlanDefinition.action0..*BackboneElementAn action or group of actions to be taken as part of the plan.
PlanDefinition.action.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.action.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.action.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.action.prefix0..1stringA user-visible prefix for the action.
PlanDefinition.action.title0..1stringThe title of the action displayed to a user.
PlanDefinition.action.description0..1stringA brief description of the action used to provide a summary to display to the user.
PlanDefinition.action.textEquivalent0..1stringA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
PlanDefinition.action.priority0..1codeIndicates how quickly the action should be addressed with respect to other actions.
PlanDefinition.action.code0..*CodeableConceptA code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
PlanDefinition.action.reason0..*CodeableConceptA description of why this action is necessary or appropriate.
PlanDefinition.action.documentation0..*RelatedArtifactDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
PlanDefinition.action.goalId0..*idIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
PlanDefinition.action.subject[x]0..1CodeableConceptA code or group definition that describes the intended subject of the action and its children, if any.
PlanDefinition.action.trigger0..*TriggerDefinitionA description of when the action should be triggered.
PlanDefinition.action.condition0..*BackboneElementAn expression that describes applicability criteria or start/stop conditions for the action.
PlanDefinition.action.condition.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.action.condition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.action.condition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.action.condition.kind1..1codeThe kind of condition.
PlanDefinition.action.condition.expression0..1ExpressionAn expression that returns true or false, indicating whether the condition is satisfied.
PlanDefinition.action.input0..*DataRequirementDefines input data requirements for the action.
PlanDefinition.action.output0..*DataRequirementDefines the outputs of the action, if any.
PlanDefinition.action.relatedAction0..*BackboneElementA relationship to another action such as "before" or "30-60 minutes after start of".
PlanDefinition.action.relatedAction.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.action.relatedAction.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.action.relatedAction.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.action.relatedAction.actionId1..1idThe element id of the related action.
PlanDefinition.action.relatedAction.relationship1..1codeThe relationship of this action to the related action.
PlanDefinition.action.relatedAction.offset[x]0..1DurationA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
PlanDefinition.action.timing[x]0..1dateTimeAn optional value describing when the action should be performed.
PlanDefinition.action.participant0..*BackboneElementIndicates who should participate in performing the action described.
PlanDefinition.action.participant.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.action.participant.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.action.participant.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.action.participant.type1..1codeThe type of participant in the action.
PlanDefinition.action.participant.role0..1CodeableConceptThe role the participant should play in performing the described action.
PlanDefinition.action.type0..1CodeableConceptThe type of action to perform (create, update, remove).
PlanDefinition.action.groupingBehavior0..1codeDefines the grouping behavior for the action and its children.
PlanDefinition.action.selectionBehavior0..1codeDefines the selection behavior for the action and its children.
PlanDefinition.action.requiredBehavior0..1codeDefines the required behavior for the action.
PlanDefinition.action.precheckBehavior0..1codeDefines whether the action should usually be preselected.
PlanDefinition.action.cardinalityBehavior0..1codeDefines whether the action can be selected multiple times.
PlanDefinition.action.definition[x]0..1canonicalA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
PlanDefinition.action.transform0..1canonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
PlanDefinition.action.dynamicValue0..*BackboneElementCustomizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
PlanDefinition.action.dynamicValue.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PlanDefinition.action.dynamicValue.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PlanDefinition.action.dynamicValue.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PlanDefinition.action.dynamicValue.path0..1stringThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
PlanDefinition.action.dynamicValue.expression0..1ExpressionAn expression specifying the value of the customized element.
PlanDefinition.action.action0..*PlanDefinitionSub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
composed-ofreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='composed-of').resource
contexttokenA use context assigned to the plan definition(PlanDefinition.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the plan definition(PlanDefinition.useContext.value.ofType(Quantity)) / (PlanDefinition.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the plan definitionPlanDefinition.useContext.code
datedateThe plan definition publication datePlanDefinition.date
definitionreferenceActivity or plan definitions used by plan definitionPlanDefinition.action.definition
depends-onreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='depends-on').resource / PlanDefinition.library
derived-fromreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='derived-from').resource
descriptionstringThe description of the plan definitionPlanDefinition.description
effectivedateThe time during which the plan definition is intended to be in usePlanDefinition.effectivePeriod
identifiertokenExternal identifier for the plan definitionPlanDefinition.identifier
jurisdictiontokenIntended jurisdiction for the plan definitionPlanDefinition.jurisdiction
namestringComputationally friendly name of the plan definitionPlanDefinition.name
predecessorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='predecessor').resource
publisherstringName of the publisher of the plan definitionPlanDefinition.publisher
statustokenThe current status of the plan definitionPlanDefinition.status
successorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='successor').resource
titlestringThe human-friendly name of the plan definitionPlanDefinition.title
topictokenTopics associated with the modulePlanDefinition.topic
typetokenThe type of artifact the plan (e.g. order-set, eca-rule, protocol)PlanDefinition.type
urluriThe uri that identifies the plan definitionPlanDefinition.url
versiontokenThe business version of the plan definitionPlanDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the plan definitionPlanDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the plan definitionPlanDefinition.useContext
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value