This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: CPG Workflow Definition

Profile of PlanDefinition as a Workflow Definition for use with CPG Implementation Guide

Usage:

• Examples for this Resource Profile: PlanDefinition_CPG_Common_Registration

Formal Views of Profile Content

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

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

This structure is derived from CPGComputablePlanDefinition

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition		0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
type		1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
action
title		1..1	string	User-visible title
description		1..1	string	Brief description of the action
code		1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
participant
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
type		0..0
groupingBehavior		0..0
selectionBehavior		0..0
requiredBehavior		0..0
precheckBehavior		0..0
cardinalityBehavior		0..0
transform		0..0
dynamicValue		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	C	0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
enabled	S	0..1	boolean	CPG Enabled Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
partOf	S	0..1	canonical(PlanDefinition)	CPG Part Of Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
subject[x]	S	0..1		Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
library	S	0..1	canonical(Library)	Logic used by the plan definition
action	S	1..*	BackboneElement	Action defined by the plan
strengthOfRecommendation	S	0..1	CodeableConcept	The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example)
directionOfRecommendation	S	0..1	CodeableConcept	CPG Direction Of Recommendation Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation Binding: CPG Recommendation Direction Value Set (required): The direction of the recommendation, for or against
qualityOfEvidence	S	0..1	CodeableConcept	The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix	S	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	1..1	string	User-visible title
description	S	1..1	string	Brief description of the action
code	S	1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
reason	S	0..*	CodeableConcept	Why the action should be performed
documentation	S	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
trigger	S	0..*	TriggerDefinition	When the action should be triggered
condition	S	0..*	BackboneElement	Whether or not the action is applicable
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action is this related to
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.
timing[x]	S	0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant	S	0..*	BackboneElement	Who should participate in the action
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role	S	0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona Value Set (preferred): Personas used in identifying participants and their roles in computable content
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition | PlanDefinition | Questionnaire)
definitionUri			uri
action	S	0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
PlanDefinition.type	extensible	Pattern: workflow-definition
PlanDefinition.status	required	PublicationStatus
PlanDefinition.subject[x]	extensible	SubjectType
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)
PlanDefinition.action.condition.kind	required	ActionConditionKind
PlanDefinition.action.relatedAction.relationship	required	ActionRelationshipType
PlanDefinition.action.participant.type	required	ActionParticipantType
PlanDefinition.action.participant.role	preferred	CPGCommonPersonaVS (a valid code from CPG Common Personas Code System)

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PlanDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pdf-0	warning	PlanDefinition	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	C	0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
enabled	S	0..1	boolean	CPG Enabled Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
partOf	S	0..1	canonical(PlanDefinition)	CPG Part Of Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier	Σ	0..*	Identifier	Additional identifier for the plan definition
version	Σ	0..1	string	Business version of the plan definition
name	ΣC	0..1	string	Name for this plan definition (computer friendly)
title	Σ	0..1	string	Name for this plan definition (human friendly)
subtitle		0..1	string	Subordinate title of the plan definition
type	SΣ	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
subject[x]	S	0..1		Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the plan definition
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this plan definition is defined
usage		0..1	string	Describes the clinical usage of the plan
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the plan definition was approved by publisher
lastReviewDate		0..1	date	When the plan definition was last reviewed
effectivePeriod	Σ	0..1	Period	When the plan definition is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
relatedArtifact		0..*	RelatedArtifact	Additional documentation, citations
library	S	0..1	canonical(Library)	Logic used by the plan definition
goal		0..*	BackboneElement	What the plan is trying to accomplish
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
category		0..1	CodeableConcept	E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description		1..1	CodeableConcept	Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
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.
start		0..1	CodeableConcept	When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses		0..*	CodeableConcept	What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation		0..*	RelatedArtifact	Supporting documentation for the goal
target		0..*	BackboneElement	Target outcome for the goal
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
measure		0..1	CodeableConcept	The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x]		0..1		The target value to be achieved
detailQuantity			Quantity
detailRange			Range
detailCodeableConcept			CodeableConcept
due		0..1	Duration	Reach goal within
action	S	1..*	BackboneElement	Action defined by the plan
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
strengthOfRecommendation	S	0..1	CodeableConcept	The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example)
directionOfRecommendation	S	0..1	CodeableConcept	CPG Direction Of Recommendation Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation Binding: CPG Recommendation Direction Value Set (required): The direction of the recommendation, for or against
qualityOfEvidence	S	0..1	CodeableConcept	The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix	S	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	1..1	string	User-visible title
description	S	1..1	string	Brief description of the action
textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code	S	1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
reason	S	0..*	CodeableConcept	Why the action should be performed
documentation	S	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goalId		0..*	id	What goals this action supports
subject[x]		0..1		Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
trigger	S	0..*	TriggerDefinition	When the action should be triggered
condition	S	0..*	BackboneElement	Whether or not the action is applicable
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression		0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action is this related to
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.
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]	S	0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant	S	0..*	BackboneElement	Who should participate in the action
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role	S	0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona Value Set (preferred): Personas used in identifying participants and their roles in computable content
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition | PlanDefinition | Questionnaire)
definitionUri			uri
action	S	0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
PlanDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
PlanDefinition.type	extensible	Pattern: workflow-definition
PlanDefinition.status	required	PublicationStatus
PlanDefinition.subject[x]	extensible	SubjectType
PlanDefinition.jurisdiction	extensible	Jurisdiction ValueSet
PlanDefinition.topic	example	DefinitionTopic
PlanDefinition.goal.category	example	GoalCategory
PlanDefinition.goal.description	example	SNOMEDCTClinicalFindings
PlanDefinition.goal.priority	preferred	GoalPriority
PlanDefinition.goal.start	example	GoalStartEvent
PlanDefinition.goal.addresses	example	Condition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measure	example	LOINCCodes (a valid code from LOINC)
PlanDefinition.action.priority	required	RequestPriority
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)
PlanDefinition.action.subject[x]	extensible	SubjectType
PlanDefinition.action.condition.kind	required	ActionConditionKind
PlanDefinition.action.relatedAction.relationship	required	ActionRelationshipType
PlanDefinition.action.participant.type	required	ActionParticipantType
PlanDefinition.action.participant.role	preferred	CPGCommonPersonaVS (a valid code from CPG Common Personas Code System)

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PlanDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pdf-0	warning	PlanDefinition	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from CPGComputablePlanDefinition

Summary

Mandatory: 3 elements
Must-Support: 4 elements
Prohibited: 8 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement

Differential View

This structure is derived from CPGComputablePlanDefinition

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition		0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
type		1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
action
title		1..1	string	User-visible title
description		1..1	string	Brief description of the action
code		1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
participant
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
type		0..0
groupingBehavior		0..0
selectionBehavior		0..0
requiredBehavior		0..0
precheckBehavior		0..0
cardinalityBehavior		0..0
transform		0..0
dynamicValue		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	C	0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
enabled	S	0..1	boolean	CPG Enabled Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
partOf	S	0..1	canonical(PlanDefinition)	CPG Part Of Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
subject[x]	S	0..1		Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
library	S	0..1	canonical(Library)	Logic used by the plan definition
action	S	1..*	BackboneElement	Action defined by the plan
strengthOfRecommendation	S	0..1	CodeableConcept	The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example)
directionOfRecommendation	S	0..1	CodeableConcept	CPG Direction Of Recommendation Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation Binding: CPG Recommendation Direction Value Set (required): The direction of the recommendation, for or against
qualityOfEvidence	S	0..1	CodeableConcept	The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix	S	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	1..1	string	User-visible title
description	S	1..1	string	Brief description of the action
code	S	1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
reason	S	0..*	CodeableConcept	Why the action should be performed
documentation	S	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
trigger	S	0..*	TriggerDefinition	When the action should be triggered
condition	S	0..*	BackboneElement	Whether or not the action is applicable
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action is this related to
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.
timing[x]	S	0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant	S	0..*	BackboneElement	Who should participate in the action
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role	S	0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona Value Set (preferred): Personas used in identifying participants and their roles in computable content
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition | PlanDefinition | Questionnaire)
definitionUri			uri
action	S	0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
PlanDefinition.type	extensible	Pattern: workflow-definition
PlanDefinition.status	required	PublicationStatus
PlanDefinition.subject[x]	extensible	SubjectType
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)
PlanDefinition.action.condition.kind	required	ActionConditionKind
PlanDefinition.action.relatedAction.relationship	required	ActionRelationshipType
PlanDefinition.action.participant.type	required	ActionParticipantType
PlanDefinition.action.participant.role	preferred	CPGCommonPersonaVS (a valid code from CPG Common Personas Code System)

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PlanDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pdf-0	warning	PlanDefinition	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	C	0..*	CPGComputablePlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
enabled	S	0..1	boolean	CPG Enabled Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
partOf	S	0..1	canonical(PlanDefinition)	CPG Part Of Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier	Σ	0..*	Identifier	Additional identifier for the plan definition
version	Σ	0..1	string	Business version of the plan definition
name	ΣC	0..1	string	Name for this plan definition (computer friendly)
title	Σ	0..1	string	Name for this plan definition (human friendly)
subtitle		0..1	string	Subordinate title of the plan definition
type	SΣ	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: workflow-definition
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
subject[x]	S	0..1		Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	Σ	0..1	markdown	Natural language description of the plan definition
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this plan definition is defined
usage		0..1	string	Describes the clinical usage of the plan
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the plan definition was approved by publisher
lastReviewDate		0..1	date	When the plan definition was last reviewed
effectivePeriod	Σ	0..1	Period	When the plan definition is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
relatedArtifact		0..*	RelatedArtifact	Additional documentation, citations
library	S	0..1	canonical(Library)	Logic used by the plan definition
goal		0..*	BackboneElement	What the plan is trying to accomplish
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
category		0..1	CodeableConcept	E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description		1..1	CodeableConcept	Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
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.
start		0..1	CodeableConcept	When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses		0..*	CodeableConcept	What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation		0..*	RelatedArtifact	Supporting documentation for the goal
target		0..*	BackboneElement	Target outcome for the goal
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
measure		0..1	CodeableConcept	The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x]		0..1		The target value to be achieved
detailQuantity			Quantity
detailRange			Range
detailCodeableConcept			CodeableConcept
due		0..1	Duration	Reach goal within
action	S	1..*	BackboneElement	Action defined by the plan
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
strengthOfRecommendation	S	0..1	CodeableConcept	The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example)
directionOfRecommendation	S	0..1	CodeableConcept	CPG Direction Of Recommendation Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation Binding: CPG Recommendation Direction Value Set (required): The direction of the recommendation, for or against
qualityOfEvidence	S	0..1	CodeableConcept	The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix	S	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	1..1	string	User-visible title
description	S	1..1	string	Brief description of the action
textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code	S	1..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: CPG Common Process Value Set (extensible): High-level processes identified in guideline-based care
reason	S	0..*	CodeableConcept	Why the action should be performed
documentation	S	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goalId		0..*	id	What goals this action supports
subject[x]		0..1		Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
trigger	S	0..*	TriggerDefinition	When the action should be triggered
condition	S	0..*	BackboneElement	Whether or not the action is applicable
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression		0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
output	S	0..*	DataRequirement	Output data definition
relatedAction	S	0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action is this related to
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.
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]	S	0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant	S	0..*	BackboneElement	Who should participate in the action
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
participantCapabilityStatement	S	0..1	canonical(CapabilityStatement)	CPG Participant Capability Statement Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role	S	0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona Value Set (preferred): Personas used in identifying participants and their roles in computable content
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition | PlanDefinition | Questionnaire)
definitionUri			uri
action	S	0..*	See action (PlanDefinition)	A sub-action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
PlanDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
PlanDefinition.type	extensible	Pattern: workflow-definition
PlanDefinition.status	required	PublicationStatus
PlanDefinition.subject[x]	extensible	SubjectType
PlanDefinition.jurisdiction	extensible	Jurisdiction ValueSet
PlanDefinition.topic	example	DefinitionTopic
PlanDefinition.goal.category	example	GoalCategory
PlanDefinition.goal.description	example	SNOMEDCTClinicalFindings
PlanDefinition.goal.priority	preferred	GoalPriority
PlanDefinition.goal.start	example	GoalStartEvent
PlanDefinition.goal.addresses	example	Condition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measure	example	LOINCCodes (a valid code from LOINC)
PlanDefinition.action.priority	required	RequestPriority
PlanDefinition.action.code	extensible	CPGCommonProcessVS (a valid code from CPG Common Process Code System)
PlanDefinition.action.subject[x]	extensible	SubjectType
PlanDefinition.action.condition.kind	required	ActionConditionKind
PlanDefinition.action.relatedAction.relationship	required	ActionRelationshipType
PlanDefinition.action.participant.type	required	ActionParticipantType
PlanDefinition.action.participant.role	preferred	CPGCommonPersonaVS (a valid code from CPG Common Personas Code System)

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	PlanDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PlanDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pdf-0	warning	PlanDefinition	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from CPGComputablePlanDefinition

Summary

Mandatory: 3 elements
Must-Support: 4 elements
Prohibited: 8 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement

Other representations of profile: CSV, Excel, Schematron