RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.27.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: PlanDefinition

PlanDefinition voor het ondersteunen van filtering op basis van DataRequirements

Usages:

• CapabilityStatements using this Profile: Behandelplan
• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PlanDefinition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
PlanDefinition.experimental	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
dom-2	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	PlanDefinition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource	contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())

This structure is derived from PlanDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.action
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PlanDefinition.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PlanDefinition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PlanDefinition.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
PlanDefinition.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
PlanDefinition.contained		0..*	Resource	Contained, inline Resources
PlanDefinition.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.url	Σ This element is included in summaries.	0..1	uri	Logical URI to reference this plan definition (globally unique)
PlanDefinition.identifier	Σ This element is included in summaries.	0..*	Identifier	Additional identifier for the plan definition
PlanDefinition.version	Σ This element is included in summaries.	0..1	string	Business version of the plan definition
PlanDefinition.name	Σ This element is included in summaries.	0..1	string	Name for this plan definition (computer friendly)
PlanDefinition.title	Σ This element is included in summaries.	0..1	string	Name for this plan definition (human friendly)
PlanDefinition.type	Σ This element is included in summaries.	0..1	CodeableConcept	order-set | protocol | eca-rule Binding: PlanDefinitionType (extensible): The type of PlanDefinition
PlanDefinition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
PlanDefinition.experimental	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
PlanDefinition.date	Σ This element is included in summaries.	0..1	dateTime	Date this was last changed
PlanDefinition.publisher	Σ This element is included in summaries.	0..1	string	Name of the publisher (organization or individual)
PlanDefinition.description	Σ This element is included in summaries.	0..1	markdown	Natural language description of the plan definition
PlanDefinition.purpose		0..1	markdown	Why this plan definition is defined
PlanDefinition.usage		0..1	string	Describes the clinical usage of the asset
PlanDefinition.approvalDate		0..1	date	When the plan definition was approved by publisher
PlanDefinition.lastReviewDate		0..1	date	When the plan definition was last reviewed
PlanDefinition.effectivePeriod	Σ This element is included in summaries.	0..1	Period	When the plan definition is expected to be used
PlanDefinition.useContext	Σ This element is included in summaries.	0..*	UsageContext	Context the content is intended to support
PlanDefinition.jurisdiction	Σ This element is included in summaries.	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
PlanDefinition.topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering
PlanDefinition.contributor		0..*	Contributor	A content contributor
PlanDefinition.contact	Σ This element is included in summaries.	0..*	ContactDetail	Contact details for the publisher
PlanDefinition.copyright		0..1	markdown	Use and/or publishing restrictions
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.library		0..*	Reference(Library)	Logic used by the plan definition
PlanDefinition.goal		0..*	BackboneElement	What the plan is trying to accomplish
PlanDefinition.goal.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.goal.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.goal.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.goal.category		0..1	CodeableConcept	E.g. Treatment, dietary, behavioral, etc Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation
PlanDefinition.goal.description		1..1	CodeableConcept	Code or text describing the goal Binding: SNOMED CT Clinical Findings (example): Describes goals that can be achieved
PlanDefinition.goal.priority		0..1	CodeableConcept	high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal
PlanDefinition.goal.start		0..1	CodeableConcept	When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal
PlanDefinition.goal.addresses		0..*	CodeableConcept	What does the goal address Binding: Condition/Problem/Diagnosis Codes (example): Identifies problems, conditions, issues, or concerns that goals may address
PlanDefinition.goal.documentation		0..*	RelatedArtifact	Supporting documentation for the goal
PlanDefinition.goal.target		0..*	BackboneElement	Target outcome for the goal
PlanDefinition.goal.target.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.goal.target.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.goal.target.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.goal.target.measure		0..1	CodeableConcept	The parameter whose value is to be tracked Binding: LOINC Codes (example): Identifies types of parameters that can be tracked to determine goal achievement
PlanDefinition.goal.target.detail[x]		0..1		The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity			Quantity
PlanDefinition.goal.target.detail[x].detailRange			Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept			CodeableConcept
PlanDefinition.goal.target.due		0..1	Duration	Reach goal within
PlanDefinition.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.label		0..1	string	User-visible label for the action (e.g. 1. or A.)
PlanDefinition.action.title		0..1	string	User-visible title
PlanDefinition.action.description		0..1	string	Short description of the action
PlanDefinition.action.textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.action.code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
PlanDefinition.action.reason		0..*	CodeableConcept	Why the action should be performed
PlanDefinition.action.documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
PlanDefinition.action.goalId		0..*	id	What goals this action supports
PlanDefinition.action.triggerDefinition		0..*	TriggerDefinition	When the action should be triggered
PlanDefinition.action.condition		0..*	BackboneElement	Whether or not the action is applicable
PlanDefinition.action.condition.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.condition.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.condition.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.condition.kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions
PlanDefinition.action.condition.description		0..1	string	Natural language description of the condition
PlanDefinition.action.condition.language		0..1	string	Language of the expression
PlanDefinition.action.condition.expression		0..1	string	Boolean-valued expression
PlanDefinition.action.input		0..*	DataRequirement	Input data requirements
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
PlanDefinition.action.relatedAction		0..*	BackboneElement	Relationship to another action
PlanDefinition.action.relatedAction.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.relatedAction.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.relatedAction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.relatedAction.actionId		1..1	id	What action is this related to
PlanDefinition.action.relatedAction.relationship		1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions
PlanDefinition.action.relatedAction.offset[x]		0..1		Time offset for the relationship
PlanDefinition.action.relatedAction.offset[x].offsetDuration			Duration
PlanDefinition.action.relatedAction.offset[x].offsetRange			Range
PlanDefinition.action.timing[x]		0..1		When the action should take place
PlanDefinition.action.timing[x].timingDateTime			dateTime
PlanDefinition.action.timing[x].timingPeriod			Period
PlanDefinition.action.timing[x].timingDuration			Duration
PlanDefinition.action.timing[x].timingRange			Range
PlanDefinition.action.timing[x].timingTiming			Timing
PlanDefinition.action.participant		0..*	BackboneElement	Who should participate in the action
PlanDefinition.action.participant.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.participant.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.participant.type		1..1	code	patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant for the action
PlanDefinition.action.participant.role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action
PlanDefinition.action.type		0..1	Coding	create | update | remove | fire-event Binding: ActionType (required): The type of action to be performed
PlanDefinition.action.groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group
PlanDefinition.action.selectionBehavior		0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group
PlanDefinition.action.requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group
PlanDefinition.action.precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group
PlanDefinition.action.cardinalityBehavior		0..1	code	single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated
PlanDefinition.action.definition		0..1	Reference(ActivityDefinition | PlanDefinition)	Description of the activity to be performed
PlanDefinition.action.transform		0..1	Reference(StructureMap)	Transform to apply the template
PlanDefinition.action.dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
PlanDefinition.action.dynamicValue.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.dynamicValue.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.dynamicValue.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.dynamicValue.description		0..1	string	Natural language description of the dynamic value
PlanDefinition.action.dynamicValue.path		0..1	string	The path to the element to be set dynamically
PlanDefinition.action.dynamicValue.language		0..1	string	Language of the expression
PlanDefinition.action.dynamicValue.expression		0..1	string	An expression that provides the dynamic value for the customization
PlanDefinition.action.action		0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.language	Base	extensible	Common Languages	📍3.0.2	FHIR Std.
PlanDefinition.type	Base	extensible	PlanDefinitionType	📍3.0.2	FHIR Std.
PlanDefinition.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.
PlanDefinition.jurisdiction	Base	extensible	Jurisdiction ValueSet	📍3.0.2	FHIR Std.
PlanDefinition.topic	Base	example	DefinitionTopic	📍3.0.2	FHIR Std.
PlanDefinition.goal.​category	Base	example	GoalCategory	📍3.0.2	FHIR Std.
PlanDefinition.goal.​description	Base	example	SNOMED CT Clinical Findings	📍3.0.2	FHIR Std.
PlanDefinition.goal.​priority	Base	preferred	GoalPriority	📍3.0.2	FHIR Std.
PlanDefinition.goal.​start	Base	example	GoalStartEvent	📍3.0.2	FHIR Std.
PlanDefinition.goal.​addresses	Base	example	Condition/Problem/Diagnosis Codes	📍3.0.2	FHIR Std.
PlanDefinition.goal.​target.measure	Base	example	LOINC Codes	📍3.0.2	FHIR Std.
PlanDefinition.action.​condition.kind	Base	required	ActionConditionKind	📍3.0.2	FHIR Std.
PlanDefinition.action.​relatedAction.relationship	Base	required	ActionRelationshipType	📍3.0.2	FHIR Std.
PlanDefinition.action.​participant.type	Base	required	ActionParticipantType	📍3.0.2	FHIR Std.
PlanDefinition.action.​participant.role	Base	example	ActionParticipantRole	📍3.0.2	FHIR Std.
PlanDefinition.action.​type	Base	required	ActionType	📍3.0.2	FHIR Std.
PlanDefinition.action.​groupingBehavior	Base	required	ActionGroupingBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​selectionBehavior	Base	required	ActionSelectionBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​requiredBehavior	Base	required	ActionRequiredBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​precheckBehavior	Base	required	ActionPrecheckBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​cardinalityBehavior	Base	required	ActionCardinalityBehavior	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
dom-2	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	PlanDefinition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource	contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())

This structure is derived from PlanDefinition

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PlanDefinition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
PlanDefinition.experimental	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
dom-2	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	PlanDefinition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource	contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())

Differential View

This structure is derived from PlanDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.action
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PlanDefinition.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PlanDefinition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PlanDefinition.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
PlanDefinition.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
PlanDefinition.contained		0..*	Resource	Contained, inline Resources
PlanDefinition.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.url	Σ This element is included in summaries.	0..1	uri	Logical URI to reference this plan definition (globally unique)
PlanDefinition.identifier	Σ This element is included in summaries.	0..*	Identifier	Additional identifier for the plan definition
PlanDefinition.version	Σ This element is included in summaries.	0..1	string	Business version of the plan definition
PlanDefinition.name	Σ This element is included in summaries.	0..1	string	Name for this plan definition (computer friendly)
PlanDefinition.title	Σ This element is included in summaries.	0..1	string	Name for this plan definition (human friendly)
PlanDefinition.type	Σ This element is included in summaries.	0..1	CodeableConcept	order-set | protocol | eca-rule Binding: PlanDefinitionType (extensible): The type of PlanDefinition
PlanDefinition.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
PlanDefinition.experimental	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
PlanDefinition.date	Σ This element is included in summaries.	0..1	dateTime	Date this was last changed
PlanDefinition.publisher	Σ This element is included in summaries.	0..1	string	Name of the publisher (organization or individual)
PlanDefinition.description	Σ This element is included in summaries.	0..1	markdown	Natural language description of the plan definition
PlanDefinition.purpose		0..1	markdown	Why this plan definition is defined
PlanDefinition.usage		0..1	string	Describes the clinical usage of the asset
PlanDefinition.approvalDate		0..1	date	When the plan definition was approved by publisher
PlanDefinition.lastReviewDate		0..1	date	When the plan definition was last reviewed
PlanDefinition.effectivePeriod	Σ This element is included in summaries.	0..1	Period	When the plan definition is expected to be used
PlanDefinition.useContext	Σ This element is included in summaries.	0..*	UsageContext	Context the content is intended to support
PlanDefinition.jurisdiction	Σ This element is included in summaries.	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
PlanDefinition.topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering
PlanDefinition.contributor		0..*	Contributor	A content contributor
PlanDefinition.contact	Σ This element is included in summaries.	0..*	ContactDetail	Contact details for the publisher
PlanDefinition.copyright		0..1	markdown	Use and/or publishing restrictions
PlanDefinition.relatedArtifact	S This element must be supported.	1..*	RelatedArtifact	Related artifacts for the asset
PlanDefinition.library		0..*	Reference(Library)	Logic used by the plan definition
PlanDefinition.goal		0..*	BackboneElement	What the plan is trying to accomplish
PlanDefinition.goal.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.goal.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.goal.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.goal.category		0..1	CodeableConcept	E.g. Treatment, dietary, behavioral, etc Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation
PlanDefinition.goal.description		1..1	CodeableConcept	Code or text describing the goal Binding: SNOMED CT Clinical Findings (example): Describes goals that can be achieved
PlanDefinition.goal.priority		0..1	CodeableConcept	high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal
PlanDefinition.goal.start		0..1	CodeableConcept	When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal
PlanDefinition.goal.addresses		0..*	CodeableConcept	What does the goal address Binding: Condition/Problem/Diagnosis Codes (example): Identifies problems, conditions, issues, or concerns that goals may address
PlanDefinition.goal.documentation		0..*	RelatedArtifact	Supporting documentation for the goal
PlanDefinition.goal.target		0..*	BackboneElement	Target outcome for the goal
PlanDefinition.goal.target.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.goal.target.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.goal.target.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.goal.target.measure		0..1	CodeableConcept	The parameter whose value is to be tracked Binding: LOINC Codes (example): Identifies types of parameters that can be tracked to determine goal achievement
PlanDefinition.goal.target.detail[x]		0..1		The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity			Quantity
PlanDefinition.goal.target.detail[x].detailRange			Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept			CodeableConcept
PlanDefinition.goal.target.due		0..1	Duration	Reach goal within
PlanDefinition.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.label		0..1	string	User-visible label for the action (e.g. 1. or A.)
PlanDefinition.action.title		0..1	string	User-visible title
PlanDefinition.action.description		0..1	string	Short description of the action
PlanDefinition.action.textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.action.code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
PlanDefinition.action.reason		0..*	CodeableConcept	Why the action should be performed
PlanDefinition.action.documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
PlanDefinition.action.goalId		0..*	id	What goals this action supports
PlanDefinition.action.triggerDefinition		0..*	TriggerDefinition	When the action should be triggered
PlanDefinition.action.condition		0..*	BackboneElement	Whether or not the action is applicable
PlanDefinition.action.condition.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.condition.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.condition.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.condition.kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions
PlanDefinition.action.condition.description		0..1	string	Natural language description of the condition
PlanDefinition.action.condition.language		0..1	string	Language of the expression
PlanDefinition.action.condition.expression		0..1	string	Boolean-valued expression
PlanDefinition.action.input		0..*	DataRequirement	Input data requirements
PlanDefinition.action.output	S This element must be supported.	1..*	DataRequirement	Output data definition
PlanDefinition.action.relatedAction		0..*	BackboneElement	Relationship to another action
PlanDefinition.action.relatedAction.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.relatedAction.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.relatedAction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.relatedAction.actionId		1..1	id	What action is this related to
PlanDefinition.action.relatedAction.relationship		1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions
PlanDefinition.action.relatedAction.offset[x]		0..1		Time offset for the relationship
PlanDefinition.action.relatedAction.offset[x].offsetDuration			Duration
PlanDefinition.action.relatedAction.offset[x].offsetRange			Range
PlanDefinition.action.timing[x]		0..1		When the action should take place
PlanDefinition.action.timing[x].timingDateTime			dateTime
PlanDefinition.action.timing[x].timingPeriod			Period
PlanDefinition.action.timing[x].timingDuration			Duration
PlanDefinition.action.timing[x].timingRange			Range
PlanDefinition.action.timing[x].timingTiming			Timing
PlanDefinition.action.participant		0..*	BackboneElement	Who should participate in the action
PlanDefinition.action.participant.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.participant.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.participant.type		1..1	code	patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant for the action
PlanDefinition.action.participant.role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action
PlanDefinition.action.type		0..1	Coding	create | update | remove | fire-event Binding: ActionType (required): The type of action to be performed
PlanDefinition.action.groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group
PlanDefinition.action.selectionBehavior		0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group
PlanDefinition.action.requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group
PlanDefinition.action.precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group
PlanDefinition.action.cardinalityBehavior		0..1	code	single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated
PlanDefinition.action.definition		0..1	Reference(ActivityDefinition | PlanDefinition)	Description of the activity to be performed
PlanDefinition.action.transform		0..1	Reference(StructureMap)	Transform to apply the template
PlanDefinition.action.dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
PlanDefinition.action.dynamicValue.id		0..1	string	xml:id (or equivalent in JSON)
PlanDefinition.action.dynamicValue.extension		0..*	Extension	Additional Content defined by implementations
PlanDefinition.action.dynamicValue.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
PlanDefinition.action.dynamicValue.description		0..1	string	Natural language description of the dynamic value
PlanDefinition.action.dynamicValue.path		0..1	string	The path to the element to be set dynamically
PlanDefinition.action.dynamicValue.language		0..1	string	Language of the expression
PlanDefinition.action.dynamicValue.expression		0..1	string	An expression that provides the dynamic value for the customization
PlanDefinition.action.action		0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.language	Base	extensible	Common Languages	📍3.0.2	FHIR Std.
PlanDefinition.type	Base	extensible	PlanDefinitionType	📍3.0.2	FHIR Std.
PlanDefinition.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.
PlanDefinition.jurisdiction	Base	extensible	Jurisdiction ValueSet	📍3.0.2	FHIR Std.
PlanDefinition.topic	Base	example	DefinitionTopic	📍3.0.2	FHIR Std.
PlanDefinition.goal.​category	Base	example	GoalCategory	📍3.0.2	FHIR Std.
PlanDefinition.goal.​description	Base	example	SNOMED CT Clinical Findings	📍3.0.2	FHIR Std.
PlanDefinition.goal.​priority	Base	preferred	GoalPriority	📍3.0.2	FHIR Std.
PlanDefinition.goal.​start	Base	example	GoalStartEvent	📍3.0.2	FHIR Std.
PlanDefinition.goal.​addresses	Base	example	Condition/Problem/Diagnosis Codes	📍3.0.2	FHIR Std.
PlanDefinition.goal.​target.measure	Base	example	LOINC Codes	📍3.0.2	FHIR Std.
PlanDefinition.action.​condition.kind	Base	required	ActionConditionKind	📍3.0.2	FHIR Std.
PlanDefinition.action.​relatedAction.relationship	Base	required	ActionRelationshipType	📍3.0.2	FHIR Std.
PlanDefinition.action.​participant.type	Base	required	ActionParticipantType	📍3.0.2	FHIR Std.
PlanDefinition.action.​participant.role	Base	example	ActionParticipantRole	📍3.0.2	FHIR Std.
PlanDefinition.action.​type	Base	required	ActionType	📍3.0.2	FHIR Std.
PlanDefinition.action.​groupingBehavior	Base	required	ActionGroupingBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​selectionBehavior	Base	required	ActionSelectionBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​requiredBehavior	Base	required	ActionRequiredBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​precheckBehavior	Base	required	ActionPrecheckBehavior	📍3.0.2	FHIR Std.
PlanDefinition.action.​cardinalityBehavior	Base	required	ActionCardinalityBehavior	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
dom-2	error	PlanDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	PlanDefinition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource	contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())

This structure is derived from PlanDefinition

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron