This structure is derived from PlanDefinition .

Summary

Mandatory: 1 element
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint

This structure is derived from indicates the differences between this profile and the base PlanDefinition . structure.

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition		1..1	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
cqf-cdsHooksEndpoint cdsHooksEndpoint		1..1	uri	Service endpoint URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
action		0 .. *	BackboneElement	Action defined by the plan
title	S	0 .. 1	string	User-visible title
description	S	0 .. 1	string	Brief description of the action
priority	S	0 .. 1	code	routine | urgent | asap | stat
trigger	S	0 .. *	TriggerDefinition	When the action should be triggered
condition	S	0 .. *	BackboneElement	Whether or not the action is applicable
timing[x]	S	0 .. 1	dateTime , Age , Period , Duration , Range , Timing	When the action should take place
participant	S	0 .. *	BackboneElement	Who should participate in the action
type	S	0 .. 1	CodeableConcept	create | update | remove | fire-event
selectionBehavior	S	0 .. 1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more
definition[x]	S	0 .. 1	canonical ( ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition ) , uri	Description of the activity to be performed
Documentation for this format

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base PlanDefinition structure.

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	I C	1..1	PlanDefinition	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: Common Languages ( preferred ): IETF language tag Additional Bindings Purpose All Languages 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
cqf-cdsHooksEndpoint cdsHooksEndpoint		1..1	uri	Service endpoint URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
modifierExtension	?! Σ	0..*	Extension	Extensions that cannot be ignored
url	Σ C	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	Σ I 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	Σ	0..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType ( extensible ): The type of PlanDefinition.
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]		0..1		Type of individual the plan definition is focused on Binding: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition )
subjectCanonical			canonical ( MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition EvidenceVariable )
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher publisher/steward (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		0..*	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: SNOMED CT Clinical Findings ( 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/Diagnosis Codes ( 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: LOINC Codes ( 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
detailString			string
detailBoolean			CodeableConcept boolean
detailInteger			integer
detailRatio			Ratio
due		0..1	Duration	Reach goal within
actor		0..*	BackboneElement	Actors within the plan
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
title		0..1	string	User-visible title
description		0..1	markdown	Describes the actor
action option		1..*	BackboneElement	Who or what can be this actor
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
type		0..1	code	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType ( required ): The type of participant in the activity.
typeCanonical		0..1	canonical ( CapabilityStatement )	Who or what can participate
typeReference		0..1	Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole ( example )
action		0..*	BackboneElement	Action defined by the plan
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
prefix linkId		0..1	string	Unique id for the action in the PlanDefinition
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	0..1	string	User-visible title
description	S	0..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	S	0..1	code	routine | urgent | asap | stat Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request.
code	0..*	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: ActionCode ( example ): Provides examples of actions to be performed.
reason		0..*	CodeableConcept	Why the action should be performed Binding: ActionReasonCode ( example ): Provides examples of reasons for actions to be performed.
documentation		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: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference ( Group )
subjectCanonical			canonical (Any)
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	C	0..*	DataRequirement BackboneElement	Input data requirements
output 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
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data definition is provided
relatedData		0..1	id	What data is provided
relatedAction output	C	0..*	BackboneElement	Relationship to another action Output data definition
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 title		0..1	string	1..1 User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	string	What data is provided
relatedAction		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
targetId		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 timingDuration			Period Duration
timingDuration timingRange			Duration Range
timingRange timingTiming			Range Timing
timingTiming location		0..1	Timing CodeableReference ( Location )	Where it should happen
participant	S	0..*	BackboneElement	Who should participate in the 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
type actorId		0..1	1..1 string	What actor
type		0..1	code	careteam | device | group | healthcareservice | location | organization | patient | practitioner | related-person practitionerrole | device relatedperson Binding: ActionParticipantType ( required ): The type of participant for in the action. activity.
role typeCanonical		0..1	canonical ( CapabilityStatement )	Who or what can participate
typeReference		0..1	Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole ( example ): Defines roles played by participants for the action.
function		0..1	CodeableConcept	E.g. Author, Reviewer, Witness, etc. Binding: ActionParticipantFunction ( example )
type	S	0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType ( extensible ): The type of action to be performed.
groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior ( required ): Defines organization behavior of a group.
selectionBehavior	S	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.
requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior ( required ): Defines expectations around whether an action or action group is required.
precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior ( required ): Defines selection frequency behavior for an action or group.
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.
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical ( ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition )
definitionUri			uri
transform		0..1	canonical ( StructureMap )	Transform to apply the template
dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
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
path		0..1	string	The path to the element to be set dynamically
expression		0..1	Expression	An expression that provides the dynamic value for the customization
action		0..*	See action (PlanDefinition)	A sub-action
asNeeded[x]	Σ	0..1		Preconditions for service Binding: SNOMED CT Medication As Needed Reason Codes ( example ): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
Documentation for this format

<!-- CDS Hooks Service PlanDefinition -->

<!-- CDSHooksServicePlanDefinition -->


<PlanDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <</meta>
 <
 <
 <

 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 

     Text summary of the resource, for human interpretation --></text>
 <</contained>

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
 <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 0..1 

     Canonical identifier for this plan definition, represented as a URI (globally unique) -->
 <

 <identifier><!-- I 0..* Identifier 

     Additional identifier for the plan definition --></identifier>
 <
 <
 <
 <
 <</type>
 <
 <
 <</subject[x]>
 <
 <
 <

 <version value="[string]"/><!-- I 0..1 Business version of the plan definition -->
 <name value="[string]"/><!-- I 0..1 Name for this plan definition (computer friendly) -->
 <title value="[string]"/><!-- I 0..1 Name for this plan definition (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the plan definition -->
 <type><!-- I 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition   --></type>
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the plan definition is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail 

     Contact details for the publisher --></contact>
 <
 <

 <description value="[markdown]"/><!-- I 0..1 Natural language description of the plan definition -->
 <useContext><!-- I 0..* UsageContext 

     The context that the content is intended to support --></useContext>
 <</jurisdiction>
 <
 <
 <
 <
 <
 <

 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this plan definition is defined -->
 <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- I 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the plan definition was last reviewed -->
 <effectivePeriod><!-- I 0..1 Period 

     When the plan definition is expected to be used --></effectivePeriod>
 <</topic>
 <</author>
 <</editor>
 <</reviewer>
 <</endorser>
 <

 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 

     Additional documentation, citations --></relatedArtifact>
 <
 <

 <library value="[canonical]"/><!-- I 0..* Logic used by the plan definition -->
 <goal> I 0..* BackboneElement  <!-- I 0..* What the plan is trying to accomplish -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <</category>
  <</description>
  <</priority>
  <</start>
  <</addresses>
  <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <category><!-- I 0..1 CodeableConcept E.g. Treatment, dietary, behavioral   --></category>
  <description><!-- I 1..1 CodeableConcept Code or text describing the goal   --></description>
  <priority><!-- I 0..1 CodeableConcept high-priority | medium-priority | low-priority   --></priority>
  <start><!-- I 0..1 CodeableConcept When goal pursuit begins   --></start>
  <addresses><!-- I 0..* CodeableConcept What does the goal address   --></addresses>
  <documentation><!-- I 0..* RelatedArtifact 

      Supporting documentation for the goal --></documentation>
  <

  <target> I 0..* BackboneElement  <!-- I 0..* Target outcome for the goal -->

   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <</measure>
   <|
     </detail[x]>
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <measure><!-- I 0..1 CodeableConcept The parameter whose value is to be tracked   --></measure>
   <detail[x]><!-- I 0..1 Quantity|Range|
     CodeableConcept|string|boolean|integer|Ratio 

       The target value to be achieved --></detail[x]>
   <due><!-- I 0..1 Duration 

       Reach goal within --></due>
  </target>
 </goal>
 <

 <actor> I 0..* BackboneElement  <!-- I 0..* Actors within the plan -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <title value="[string]"/><!-- I 0..1 User-visible title -->
  <description value="[markdown]"/><!-- I 0..1 Describes the actor -->
  <option> I 1..* BackboneElement  <!-- I 1..* Who or what can be this actor -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
   <typeReference><!-- I 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent    --></role>
  </option>
 </actor>
 <action> I 0..* BackboneElement  <!-- I 0..* Action defined by the plan -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <
  <
  <
  <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <linkId value="[string]"/><!-- I 0..1 Unique id for the action in the PlanDefinition -->
  <prefix value="[string]"/><!-- I 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- I 0..1 User-visible title -->
  <description value="[string]"/><!-- I 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- I 0..1 

      Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <
  <</code>
  <</reason>
  <

  <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
  <code><!-- I 0..1 CodeableConcept Code representing the meaning of the action or sub-actions   --></code>
  <reason><!-- I 0..* CodeableConcept Why the action should be performed   --></reason>
  <documentation><!-- I 0..* RelatedArtifact 

      Supporting documentation for the intended performer of the action --></documentation>
  <
  <)|
    </subject[x]>
  <

  <goalId value="[id]"/><!-- I 0..* What goals this action supports -->
  <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|
    canonical Type of individual the action is focused on   --></subject[x]>

  <trigger><!-- I 0..* TriggerDefinition 

      When the action should be triggered --></trigger>
  <

  <condition> I 0..* BackboneElement  <!-- I 0..* Whether or not the action is applicable -->

   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <kind value="[code]"/><!-- I 1..1 applicability | start | stop   -->
   <expression><!-- I 0..1 Expression 

       Boolean-valued expression --></expression>
  </condition>
  <
      Input data requirements</input>
  <
      Output data definition</output>
  <

  <input> I 0..* BackboneElement  <!-- I 0..* Input data requirements -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[id]"/><!-- I 0..1 What data is provided -->
  </input>
  <output> I 0..* BackboneElement  <!-- I 0..* Output data definition -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[string]"/><!-- I 0..1 What data is provided -->
  </output>
  <relatedAction> I 0..* BackboneElement  <!-- I 0..* Relationship to another action -->

   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <targetId value="[id]"/><!-- I 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end   -->
   <offset[x]><!-- I 0..1 Duration|Range 

       Time offset for the relationship --></offset[x]>
  </relatedAction>
  <|
    </timing[x]>
  <

  <timing[x]><!-- I 0..1 Age|Duration|Range|Timing 
      When the action should take place --></timing[x]>
  <location><!-- I 0..1 CodeableReference 
      Where it should happen --></location>
  <participant> I 0..* BackboneElement  <!-- I 0..* Who should participate in the action -->

   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <</role>

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <actorId value="[string]"/><!-- I 0..1 What actor -->
   <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
   <typeReference><!-- I 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent    --></role>
   <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>

  </participant>
  <</type>
  <
  <
  <
  <
  <
  <

  <type><!-- I 0..1 CodeableConcept create | update | remove | fire-event   --></type>
  <groupingBehavior value="[code]"/><!-- I 0..1 visual-group | logical-group | sentence-group   -->
  <selectionBehavior value="[code]"/><!-- I 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more   -->
  <requiredBehavior value="[code]"/><!-- I 0..1 must | could | must-unless-documented   -->
  <precheckBehavior value="[code]"/><!-- I 0..1 yes | no   -->
  <cardinalityBehavior value="[code]"/><!-- I 0..1 single | multiple   -->
  <definition[x]><!-- I 0..1 canonical|uri 

      Description of the activity to be performed --></definition[x]>
  <
  <

  <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template -->
  <dynamicValue> I 0..* BackboneElement  <!-- I 0..* Dynamic aspects of the definition -->

   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <path value="[string]"/><!-- I 0..1 The path to the element to be set dynamically -->
   <expression><!-- I 0..1 Expression 

       An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- See http://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action  A sub-action --></action>
 </action>
 <asNeeded[x]><!-- I 0..1 boolean|CodeableConcept Preconditions for service   --></asNeeded[x]>

</PlanDefinition>

{ // 

{ // CDSHooksServicePlanDefinition

  // from Element: extension
    "
    "
    "
    "
    "

    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { //  

      { // Service endpoint // I R! 

        // from Element: extension
      }
    ],
    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
    "
    "
    "
    "
    "
    "
    "
    "
    "

    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // ICanonical identifier for this plan definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the plan definition
    "version" : "<string>", // IBusiness version of the plan definition
    "name" : "<string>", // IName for this plan definition (computer friendly)
    "title" : "<string>", // IName for this plan definition (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the plan definition
    "type" : { CodeableConcept }, // Iorder-set | clinical-protocol | eca-rule | workflow-definition
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // IFor testing purposes, not real usage
  // value[x]: Type of individual the plan definition is focused on. One of these 3:

    "subjectCodeableConcept" : { CodeableConcept }, // IType of individual the plan definition is focused on
    "subjectReference" : { Reference(Group) }, // IType of individual the plan definition is focused on
    "subjectCanonical" : "<canonical>", // IType of individual the plan definition is focused on
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // INatural language description of the plan definition
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for plan definition (if applicable)
    "purpose" : "<markdown>", // IWhy this plan definition is defined
    "usage" : "<string>", // IDescribes the clinical usage of the plan
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the plan definition was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the plan definition was last reviewed
    "effectivePeriod" : { Period }, // IWhen the plan definition is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations
    "library" : ["<canonical>"], // ILogic used by the plan definition
    "goal" : [{ BackboneElement }], // IWhat the plan is trying to accomplish
    "actor" : [{ BackboneElement }], // IActors within the plan
    "action" : [{ BackboneElement }], // IAction defined by the plan
  // value[x]: Preconditions for service. One of these 2:

    "asNeededBoolean" : <boolean>, // IPreconditions for service
    "asNeededCodeableConcept" : { CodeableConcept }, // IPreconditions for service

  }

Summary

Mandatory: 1 element
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base PlanDefinition structure.

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	I C	1..1	PlanDefinition	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: Common Languages ( preferred ): IETF language tag Additional Bindings Purpose All Languages 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
cqf-cdsHooksEndpoint cdsHooksEndpoint		1..1	uri	Service endpoint URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
modifierExtension	?! Σ	0..*	Extension	Extensions that cannot be ignored
url	Σ C	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	Σ I 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	Σ	0..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType ( extensible ): The type of PlanDefinition.
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]		0..1		Type of individual the plan definition is focused on Binding: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition )
subjectCanonical			canonical ( MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition EvidenceVariable )
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher publisher/steward (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		0..*	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: SNOMED CT Clinical Findings ( 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/Diagnosis Codes ( 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: LOINC Codes ( 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
detailString			string
detailBoolean		CodeableConcept	boolean
detailInteger			integer
detailRatio			Ratio
due		0..1	Duration	Reach goal within
actor		0..*	BackboneElement	Actors within the plan
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
title		0..1	string	User-visible title
description		0..1	markdown	Describes the actor
action option		1..*	BackboneElement	Who or what can be this actor
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
type		0..1	code	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType ( required ): The type of participant in the activity.
typeCanonical		0..1	canonical ( CapabilityStatement )	Who or what can participate
typeReference		0..1	Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole ( example )
action		0..*	BackboneElement	Action defined by the plan
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
prefix linkId		0..1	string	Unique id for the action in the PlanDefinition
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	S	0..1	string	User-visible title
description	S	0..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	S	0..1	code	routine | urgent | asap | stat Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request.
code	0..*	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: ActionCode ( example ): Provides examples of actions to be performed.
reason		0..*	CodeableConcept	Why the action should be performed Binding: ActionReasonCode ( example ): Provides examples of reasons for actions to be performed.
documentation		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: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference ( Group )
subjectCanonical			canonical (Any)
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	C	0..*	DataRequirement BackboneElement	Input data requirements
output 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
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data definition is provided
relatedData		0..1	id	What data is provided
relatedAction output	C	0..*	BackboneElement	Relationship to another action Output data definition
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 title		0..1	string	1..1 User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	string	What data is provided
relatedAction		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
targetId		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 timingDuration			Period Duration
timingDuration timingRange			Duration Range
timingRange timingTiming			Range Timing
timingTiming location		0..1	Timing CodeableReference ( Location )	Where it should happen
participant	S	0..*	BackboneElement	Who should participate in the 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
type actorId		0..1	1..1 string	What actor
type		0..1	code	careteam | device | group | healthcareservice | location | organization | patient | practitioner | related-person practitionerrole | device relatedperson Binding: ActionParticipantType ( required ): The type of participant for in the action. activity.
role typeCanonical		0..1	canonical ( CapabilityStatement )	Who or what can participate
typeReference		0..1	Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole ( example ): Defines roles played by participants for the action.
function		0..1	CodeableConcept	E.g. Author, Reviewer, Witness, etc. Binding: ActionParticipantFunction ( example )
type	S	0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType ( extensible ): The type of action to be performed.
groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior ( required ): Defines organization behavior of a group.
selectionBehavior	S	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.
requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior ( required ): Defines expectations around whether an action or action group is required.
precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior ( required ): Defines selection frequency behavior for an action or group.
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.
definition[x]	S	0..1		Description of the activity to be performed
definitionCanonical			canonical ( ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition )
definitionUri			uri
transform		0..1	canonical ( StructureMap )	Transform to apply the template
dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
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
path		0..1	string	The path to the element to be set dynamically
expression		0..1	Expression	An expression that provides the dynamic value for the customization
action		0..*	See action (PlanDefinition)	A sub-action
asNeeded[x]	Σ	0..1		Preconditions for service Binding: SNOMED CT Medication As Needed Reason Codes ( example ): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
Documentation for this format