This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
R5
Snapshot
#1).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Clinical
Decision
Support
Work
Group
|
Maturity
Level
:
|
Trial Use | Use Context : Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/computableplandefinition
Defines a computable PlanDefinition that specifies a single library and requires all expressions referenced from the PlanDefinition to be definitions in that single library
This
profile
was
published
on
[no
date]
Thu,
Jan
1,
1970
00:00+1000
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from PlanDefinition .
This structure is derived from PlanDefinition .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
|
1..1 | canonical ( Library ) | Logic used by the plan definition | |
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 1..1 | PlanDefinition |
The
definition
of
a
plan
for
a
series
of
actions,
independent
of
any
specific
patient
or
context
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ
|
0..1 | Meta | Metadata about the resource |
|
?!
Σ
|
0..1 | uri | A set of rules under which this content was created |
|
|
0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ
|
0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
plan
definition
|
|
Σ
|
0..1 | string | Business version of the plan definition |
|
Σ I | 0..1 | string | Name for this plan definition (computer friendly) |
|
Σ
|
0..1 | string | Name for this plan definition (human friendly) |
|
|
0..1 | string | Subordinate title of the plan definition |
|
Σ
|
0..1 | CodeableConcept |
order-set
|
clinical-protocol
|
eca-rule
|
workflow-definition
Binding: PlanDefinitionType ( extensible |
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
|
Σ
|
0..1 | boolean | For testing purposes, not real usage |
|
|
0..1 |
Type
of
individual
the
plan
definition
is
focused
on
Binding: Subject type ( extensible |
|
|
CodeableConcept | |||
|
Reference
|
|||
| canonical ( MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||
|
Σ
|
0..1 | dateTime | Date last changed |
|
Σ
|
0..1 | string | Name of the publisher (organization or individual) |
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ
|
0..1 | markdown | Natural language description of the plan definition |
|
Σ
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ
|
0..* | CodeableConcept |
Intended
jurisdiction
for
plan
definition
(if
applicable)
Binding: Jurisdiction ( extensible |
|
0..1 | markdown | Why this plan definition is defined | |
|
0..1 | string | Describes the clinical usage of the plan | |
|
0..1 | markdown | Use and/or publishing restrictions | |
|
0..1 | date | When the plan definition was approved by publisher | |
|
0..1 | date | When the plan definition was last reviewed | |
|
Σ
|
0..1 | Period | When the plan definition is expected to be used |
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment
Binding: DefinitionTopic ( example |
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations
|
|
|
1..1 | canonical ( Library ) |
Logic
used
by
the
plan
definition
|
|
|
0..* | BackboneElement |
What
the
plan
is
trying
to
accomplish
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
0..1 | CodeableConcept |
E.g.
Treatment,
dietary,
behavioral
Binding: |
|
|
1..1 | CodeableConcept |
Code
or
text
describing
the
goal
Binding: SNOMED CT Clinical Findings ( example |
|
|
0..1 | CodeableConcept |
high-priority
|
medium-priority
|
low-priority
Binding: |
|
|
0..1 | CodeableConcept |
When
goal
pursuit
begins
Binding: |
|
|
0..* | CodeableConcept |
What
does
the
goal
address
Binding: Condition/Problem/Diagnosis Codes ( example |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
goal
|
|
|
0..* | BackboneElement |
Target
outcome
for
the
goal
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
0..1 | CodeableConcept |
The
parameter
whose
value
is
to
be
tracked
Binding: LOINC Codes ( example |
|
|
0..1 | The target value to be achieved | ||
|
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
|
|||
|
|
|||
|
|
|||
| boolean | |||
![]() ![]() ![]() ![]() ![]() | integer | |||
| Ratio | |||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |
![]() ![]() |
|
0..* | BackboneElement |
Actors
within
the
plan
|
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() | 0..1 |
|
|
|
| 0..1 | markdown | Describes the actor | |
![]() ![]() ![]() | 1..* | BackboneElement |
Who
or
what
can
be
this
actor
| |
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
| ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() ![]() | 0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity. | |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
![]() ![]()
| 0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: ActionParticipantRole
(
example
)
| |
![]()
|
|
0..* | BackboneElement |
Action
defined
by
the
plan
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
0..1 | string |
|
|
|
0..1 | string |
User-visible
|
|
|
0..1 | string | User-visible title |
![]() ![]() ![]() | 0..1 | string | Brief description of the action | |
|
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: |
|
|
0..1 | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: ActionCode ( example ): Provides examples of actions to be performed. |
|
|
0..* | CodeableConcept |
Why
the
action
should
be
performed
Binding: ActionReasonCode ( example ): Provides examples of reasons for actions to be performed. |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|
|
0..* | id |
What
goals
this
action
supports
|
|
|
0..1 |
Type
of
individual
the
action
is
focused
on
Binding: Subject type ( extensible |
||
|
CodeableConcept | |||
| Reference ( Group ) | |||
|
|
|||
|
|
0..* | TriggerDefinition |
When
the
action
should
be
triggered
|
|
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
1..1 | code |
applicability
|
start
|
stop
Binding: ActionConditionKind ( required |
|
|
0..1 | Expression | Boolean-valued expression |
|
I | 0..* |
|
Input
data
requirements
|
| 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
| 0..1 | string | User-visible title | |
![]() ![]() ![]() ![]() | 0..1 | DataRequirement | What data is provided | |
![]() ![]() ![]() ![]() | 0..1 | id | What data is provided | |
![]() ![]()
|
I | 0..* |
|
Output
data
definition
|
| 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() ![]() | 0..1 | string | User-visible title | |
| 0..1 | DataRequirement | What data is provided | |
![]() ![]() ![]() ![]() | 0..1 | string | What data is provided | |
![]() ![]() ![]() |
|
0..* | BackboneElement |
Relationship
to
another
action
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
1..1 | id | What action is this related to |
|
|
1..1 | code |
before-start
|
before
|
before-end
|
concurrent-with-start
|
concurrent
|
concurrent-with-end
|
after-start
|
after
|
after-end
Binding: ActionRelationshipType ( required |
|
|
0..1 | Time offset for the relationship | |
|
Duration | |||
|
Range | |||
|
|
0..1 | When the action should take place | |
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
0..1 |
|
Where it should happen | |
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
| 0..1 | string | What actor | |
|
|
|
code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
Binding: ActionParticipantType ( required ): The type of participant in the activity. |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
|
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: ActionParticipantRole
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Binding: |
|
|
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: ActionType ( extensible |
|
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: ActionGroupingBehavior ( required |
|
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: ActionSelectionBehavior ( required |
|
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: ActionRequiredBehavior ( required |
|
|
0..1 | code |
yes
|
no
Binding: ActionPrecheckBehavior ( required |
|
|
0..1 | code |
single
|
multiple
Binding: ActionCardinalityBehavior ( required |
|
|
0..1 | Description of the activity to be performed | |
|
canonical
|
|||
|
uri | |||
|
|
0..1 | canonical ( StructureMap ) | Transform to apply the template |
|
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
0..1 | string | The path to the element to be set dynamically |
|
|
0..1 | Expression | An expression that provides the dynamic value for the customization |
|
|
0..* | See action (PlanDefinition) |
|
Documentation
for
this
format
|
||||
<!-- Computable PlanDefinition -->![]()
< xmlns="http://hl7.org/fhir"<PlanDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --><</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!--
0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the plan definition --></identifier> <version value="[string]"/><!--
0..1 Business version of the plan definition --> <name value="[string]"/><!--
0..1 Name for this plan definition (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this plan definition (human friendly) --> <subtitle value="[string]"/><!--
0..1 Subordinate title of the plan definition --> <type><!--
0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
0..1 For testing purposes, not real usage -->
<</subject[x]><subject[x]><!--0..1 CodeableConcept|Reference(Group)|canonical Type of individual the plan definition is focused on --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
0..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
0..1 Natural language description of the plan definition --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this plan definition is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the plan --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the plan definition was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the plan definition was last reviewed --> <effectivePeriod><!--
0..1 Period When the plan definition is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations --></relatedArtifact> <library value="[canonical]"/><!--
1..1 Logic used by the plan definition -->
<<goal>0..* BackboneElement <!--
0..* What the plan is trying to accomplish --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <category><!--
0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category> <description><!--
1..1 CodeableConcept Code or text describing the goal --></description> <priority><!--
0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority> <start><!--
0..1 CodeableConcept When goal pursuit begins --></start> <addresses><!--
0..* CodeableConcept What does the goal address --></addresses> <documentation><!--
0..* RelatedArtifact Supporting documentation for the goal --></documentation>
<<target>0..* BackboneElement <!--
0..* Target outcome for the goal --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <measure><!--
0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
<| </detail[x]><detail[x]><!--0..1 Quantity|Range| CodeableConcept|string|boolean|integer|Ratio The target value to be achieved --></detail[x]> <due><!--
0..1 Duration Reach goal within --></due> </target> </goal>
<<actor>0..* BackboneElement <!--
0..* Actors within the plan --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <description value="[markdown]"/><!--
0..1 Describes the actor --> <option>
1..* BackboneElement <!--
1..* Who or what can be this actor --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!--
0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeReference><!--
0..1 Reference(CareTeam) Who or what can participate --></typeReference> <role><!--
0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
--></role> </option> </actor> <action>
0..* BackboneElement <!--
0..* Action defined by the plan --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
< <<linkId value="[string]"/><!--0..1 Unique id for the action in the PlanDefinition --> <prefix value="[string]"/><!--
0..1 User-visible prefix for the action (e.g. 1. or A.) --> <title value="[string]"/><!--
0..1 User-visible title --> <description value="[string]"/><!--
0..1 Brief description of the action --> <textEquivalent value="[string]"/><!--
0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <priority value="[code]"/><!--
0..1 routine | urgent | asap | stat -->
< Code representing the meaning of the action or sub-actions</code> < Why the action should be performed</reason><code><!--0..1 CodeableConcept Code representing the meaning of the action or sub-actions --></code> <reason><!--
0..* CodeableConcept Why the action should be performed --></reason> <documentation><!--
0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
< <</subject[x]><goalId value="[id]"/><!--0..* What goals this action supports --> <subject[x]><!--
0..1 CodeableConcept|Reference(Group)| canonical Type of individual the action is focused on --></subject[x]> <trigger><!--
0..* TriggerDefinition When the action should be triggered --></trigger>
<<condition>0..* BackboneElement <!--
0..* Whether or not the action is applicable --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <kind value="[code]"/><!--
1..1 applicability | start | stop --> <expression><!--
0..1 Expression Boolean-valued expression --></expression> </condition>
< Input data requirements</input> < Output data definition</output> <<input>0..* BackboneElement <!--
0..* Input data requirements --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <requirement><!--
0..1 DataRequirement What data is provided --></requirement> <relatedData value="[id]"/><!--
0..1 What data is provided --> </input> <output>
0..* BackboneElement <!--
0..* Output data definition --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <requirement><!--
0..1 DataRequirement What data is provided --></requirement> <relatedData value="[string]"/><!--
0..1 What data is provided --> </output> <relatedAction>
0..* BackboneElement <!--
0..* Relationship to another action --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<targetId value="[id]"/><!--1..1 What action is this related to --> <relationship value="[code]"/><!--
1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <offset[x]><!--
0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction>
<| </timing[x]> <<timing[x]><!--0..1 Age|Duration|Range|Timing When the action should take place --></timing[x]> <location><!--
0..1 CodeableReference Where it should happen --></location> <participant>
0..* BackboneElement <!--
0..* Who should participate in the action --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
< <</role><actorId value="[string]"/><!--0..1 What actor --> <type value="[code]"/><!--
0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeReference><!--
0..1 Reference(CareTeam) Who or what can participate --></typeReference> <role><!--
0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
--></role> <function><!--
0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function> </participant> <type><!--
0..1 CodeableConcept create | update | remove | fire-event --></type> <groupingBehavior value="[code]"/><!--
0..1 visual-group | logical-group | sentence-group --> <selectionBehavior value="[code]"/><!--
0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more --> <requiredBehavior value="[code]"/><!--
0..1 must | could | must-unless-documented --> <precheckBehavior value="[code]"/><!--
0..1 yes | no --> <cardinalityBehavior value="[code]"/><!--
0..1 single | multiple -->
<<definition[x]><!--0..1 canonical|uri Description of the activity to be performed --></definition[x]> <transform value="[canonical]"/><!--
0..1 Transform to apply the template -->
<<dynamicValue>0..* BackboneElement <!--
0..* Dynamic aspects of the definition --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<path value="[string]"/><!--0..1 The path to the element to be set dynamically --> <expression><!--
0..1 Expression An expression that provides the dynamic value for the customization --></expression> </dynamicValue>
<</action><action><!-- See http://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action A sub-action --></action> </action> </PlanDefinition>
{ // Computable PlanDefinition
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C?Canonical identifier for this plan definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the plan definition
"version" : "<string>", // C?Business version of the plan definition
"name" : "<string>", // C?Name for this plan definition (computer friendly)
"title" : "<string>", // C?Name for this plan definition (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the plan definition
"type" : { CodeableConcept }, // C?order-set | clinical-protocol | eca-rule | workflow-definition
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C?For testing purposes, not real usage
"
"
// value[x]: Type of individual the plan definition is focused on. One of these 3:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the plan definition is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the plan definition is focused on
"subjectCanonical" : "<canonical>", // C?Type of individual the plan definition is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C?Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C?Natural language description of the plan definition
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for plan definition (if applicable)
"purpose" : "<markdown>", // C?Why this plan definition is defined
"usage" : "<string>", // C?Describes the clinical usage of the plan
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the plan definition was approved by publisher
"lastReviewDate" : "<date>", // C?When the plan definition was last reviewed
"effectivePeriod" : { Period }, // C?When the plan definition is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations
"library" : "<canonical>", // C? R! Logic used by the plan definition
"
"
"goal" : [{ BackboneElement }] // C?What the plan is trying to accomplish
"actor" : [{ BackboneElement }], // C?Actors within the plan
"action" : [{ BackboneElement }], // C?Action defined by the plan
}
This structure is derived from PlanDefinition .
Differential View
This structure is derived from PlanDefinition .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
|
1..1 | canonical ( Library ) | Logic used by the plan definition | |
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 1..1 | PlanDefinition |
The
definition
of
a
plan
for
a
series
of
actions,
independent
of
any
specific
patient
or
context
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ
|
0..1 | Meta | Metadata about the resource |
|
?!
Σ
|
0..1 | uri | A set of rules under which this content was created |
|
|
0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
|
0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ
|
0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
|
Σ
|
0..* | Identifier |
Additional
identifier
for
the
plan
definition
|
|
Σ
|
0..1 | string | Business version of the plan definition |
|
Σ I | 0..1 | string | Name for this plan definition (computer friendly) |
|
Σ
|
0..1 | string | Name for this plan definition (human friendly) |
|
|
0..1 | string | Subordinate title of the plan definition |
|
Σ
|
0..1 | CodeableConcept |
order-set
|
clinical-protocol
|
eca-rule
|
workflow-definition
Binding: PlanDefinitionType ( extensible |
|
?!
Σ
|
1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required |
|
Σ
|
0..1 | boolean | For testing purposes, not real usage |
|
|
0..1 |
Type
of
individual
the
plan
definition
is
focused
on
Binding: Subject type ( extensible |
|
|
CodeableConcept | |||
|
Reference
|
|||
| canonical ( MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||
|
Σ
|
0..1 | dateTime | Date last changed |
|
Σ
|
0..1 | string | Name of the publisher (organization or individual) |
|
Σ
|
0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ
|
0..1 | markdown | Natural language description of the plan definition |
|
Σ
|
0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ
|
0..* | CodeableConcept |
Intended
jurisdiction
for
plan
definition
(if
applicable)
Binding: Jurisdiction ( extensible |
|
0..1 | markdown | Why this plan definition is defined | |
|
0..1 | string | Describes the clinical usage of the plan | |
|
0..1 | markdown | Use and/or publishing restrictions | |
|
0..1 | date | When the plan definition was approved by publisher | |
|
0..1 | date | When the plan definition was last reviewed | |
|
Σ
|
0..1 | Period | When the plan definition is expected to be used |
|
0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment
Binding: DefinitionTopic ( example |
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations
|
|
|
1..1 | canonical ( Library ) |
Logic
used
by
the
plan
definition
|
|
|
0..* | BackboneElement |
What
the
plan
is
trying
to
accomplish
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
0..1 | CodeableConcept |
E.g.
Treatment,
dietary,
behavioral
Binding: |
|
|
1..1 | CodeableConcept |
Code
or
text
describing
the
goal
Binding: SNOMED CT Clinical Findings ( example |
|
|
0..1 | CodeableConcept |
high-priority
|
medium-priority
|
low-priority
Binding: |
|
|
0..1 | CodeableConcept |
When
goal
pursuit
begins
Binding: |
|
|
0..* | CodeableConcept |
What
does
the
goal
address
Binding: Condition/Problem/Diagnosis Codes ( example |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
goal
|
|
|
0..* | BackboneElement |
Target
outcome
for
the
goal
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
0..1 | CodeableConcept |
The
parameter
whose
value
is
to
be
tracked
Binding: LOINC Codes ( example |
|
|
0..1 | The target value to be achieved | ||
|
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
|
|||
|
|
|||
|
|
|||
| boolean | |||
![]() ![]() ![]() ![]() ![]() | integer | |||
| Ratio | |||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |
![]() ![]() |
|
0..* | BackboneElement |
Actors
within
the
plan
|
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() | 0..1 |
|
|
|
| 0..1 | markdown | Describes the actor | |
![]() ![]() ![]() | 1..* | BackboneElement |
Who
or
what
can
be
this
actor
| |
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() ![]() | 0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity. | |
| 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
![]() ![]()
| 0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: ActionParticipantRole
(
example
)
| |
![]()
|
|
0..* | BackboneElement |
Action
defined
by
the
plan
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
0..1 | string |
|
|
|
0..1 | string |
User-visible
|
|
|
0..1 | string | User-visible title |
![]() ![]() ![]() | 0..1 | string | Brief description of the action | |
|
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: |
|
|
0..1 | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: ActionCode ( example ): Provides examples of actions to be performed. |
|
|
0..* | CodeableConcept |
Why
the
action
should
be
performed
Binding: ActionReasonCode ( example ): Provides examples of reasons for actions to be performed. |
|
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|
|
0..* | id |
What
goals
this
action
supports
|
|
|
0..1 |
Type
of
individual
the
action
is
focused
on
Binding: Subject type ( extensible |
||
|
CodeableConcept | |||
| Reference ( Group ) | |||
|
|
|||
|
|
0..* | TriggerDefinition |
When
the
action
should
be
triggered
|
|
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
1..1 | code |
applicability
|
start
|
stop
Binding: ActionConditionKind ( required |
|
|
0..1 | Expression | Boolean-valued expression |
|
I | 0..* |
|
Input
data
requirements
|
| 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
| 0..1 | string | User-visible title | |
![]() ![]() ![]() ![]() | 0..1 | DataRequirement | What data is provided | |
![]() ![]() ![]() ![]() | 0..1 | id | What data is provided | |
![]() ![]()
|
I | 0..* |
|
Output
data
definition
|
| 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |
| ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
![]() ![]() ![]() ![]() | 0..1 | string | User-visible title | |
![]() ![]() ![]() ![]() | 0..1 | DataRequirement | What data is provided | |
![]() ![]() ![]() ![]() | 0..1 | string | What data is provided | |
![]() ![]()
|
|
0..* | BackboneElement |
Relationship
to
another
action
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
1..1 | id | What action is this related to |
|
|
1..1 | code |
before-start
|
before
|
before-end
|
concurrent-with-start
|
concurrent
|
concurrent-with-end
|
after-start
|
after
|
after-end
Binding: ActionRelationshipType ( required |
|
|
0..1 | Time offset for the relationship | |
|
Duration | |||
|
Range | |||
|
|
0..1 | When the action should take place | |
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
0..1 |
|
Where it should happen | |
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
| 0..1 | string | What actor | |
|
|
|
code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
Binding: ActionParticipantType ( required ): The type of participant in the activity. |
![]() ![]() ![]() ![]() | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |
|
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: ActionParticipantRole
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
E.g.
Binding: |
|
|
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: ActionType ( extensible |
|
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: ActionGroupingBehavior ( required |
|
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: ActionSelectionBehavior ( required |
|
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: ActionRequiredBehavior ( required |
|
|
0..1 | code |
yes
|
no
Binding: ActionPrecheckBehavior ( required |
|
|
0..1 | code |
single
|
multiple
Binding: ActionCardinalityBehavior ( required |
|
|
0..1 | Description of the activity to be performed | |
|
canonical
|
|||
|
uri | |||
|
|
0..1 | canonical ( StructureMap ) | Transform to apply the template |
|
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|
?!
Σ
|
0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
|
0..1 | string | The path to the element to be set dynamically |
|
|
0..1 | Expression | An expression that provides the dynamic value for the customization |
|
|
0..* | See action (PlanDefinition) |
|
Documentation
for
this
format
|
||||
XML Template
<!-- Computable PlanDefinition -->![]()
< xmlns="http://hl7.org/fhir"<PlanDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --><</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!--
0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the plan definition --></identifier> <version value="[string]"/><!--
0..1 Business version of the plan definition --> <name value="[string]"/><!--
0..1 Name for this plan definition (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this plan definition (human friendly) --> <subtitle value="[string]"/><!--
0..1 Subordinate title of the plan definition --> <type><!--
0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
0..1 For testing purposes, not real usage -->
<</subject[x]><subject[x]><!--0..1 CodeableConcept|Reference(Group)|canonical Type of individual the plan definition is focused on --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
0..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
0..1 Natural language description of the plan definition --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this plan definition is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the plan --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the plan definition was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the plan definition was last reviewed --> <effectivePeriod><!--
0..1 Period When the plan definition is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations --></relatedArtifact> <library value="[canonical]"/><!--
1..1 Logic used by the plan definition -->
<<goal>0..* BackboneElement <!--
0..* What the plan is trying to accomplish --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <category><!--
0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category> <description><!--
1..1 CodeableConcept Code or text describing the goal --></description> <priority><!--
0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority> <start><!--
0..1 CodeableConcept When goal pursuit begins --></start> <addresses><!--
0..* CodeableConcept What does the goal address --></addresses> <documentation><!--
0..* RelatedArtifact Supporting documentation for the goal --></documentation>
<<target>0..* BackboneElement <!--
0..* Target outcome for the goal --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <measure><!--
0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
<| </detail[x]><detail[x]><!--0..1 Quantity|Range| CodeableConcept|string|boolean|integer|Ratio The target value to be achieved --></detail[x]> <due><!--
0..1 Duration Reach goal within --></due> </target> </goal>
<<actor>0..* BackboneElement <!--
0..* Actors within the plan --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <description value="[markdown]"/><!--
0..1 Describes the actor --> <option>
1..* BackboneElement <!--
1..* Who or what can be this actor --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!--
0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeReference><!--
0..1 Reference(CareTeam) Who or what can participate --></typeReference> <role><!--
0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
--></role> </option> </actor> <action>
0..* BackboneElement <!--
0..* Action defined by the plan --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
< <<linkId value="[string]"/><!--0..1 Unique id for the action in the PlanDefinition --> <prefix value="[string]"/><!--
0..1 User-visible prefix for the action (e.g. 1. or A.) --> <title value="[string]"/><!--
0..1 User-visible title --> <description value="[string]"/><!--
0..1 Brief description of the action --> <textEquivalent value="[string]"/><!--
0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <priority value="[code]"/><!--
0..1 routine | urgent | asap | stat -->
< Code representing the meaning of the action or sub-actions</code> < Why the action should be performed</reason><code><!--0..1 CodeableConcept Code representing the meaning of the action or sub-actions --></code> <reason><!--
0..* CodeableConcept Why the action should be performed --></reason> <documentation><!--
0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
< <</subject[x]><goalId value="[id]"/><!--0..* What goals this action supports --> <subject[x]><!--
0..1 CodeableConcept|Reference(Group)| canonical Type of individual the action is focused on --></subject[x]> <trigger><!--
0..* TriggerDefinition When the action should be triggered --></trigger>
<<condition>0..* BackboneElement <!--
0..* Whether or not the action is applicable --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <kind value="[code]"/><!--
1..1 applicability | start | stop --> <expression><!--
0..1 Expression Boolean-valued expression --></expression> </condition>
< Input data requirements</input> < Output data definition</output> <<input>0..* BackboneElement <!--
0..* Input data requirements --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <requirement><!--
0..1 DataRequirement What data is provided --></requirement> <relatedData value="[id]"/><!--
0..1 What data is provided --> </input> <output>
0..* BackboneElement <!--
0..* Output data definition --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <title value="[string]"/><!--
0..1 User-visible title --> <requirement><!--
0..1 DataRequirement What data is provided --></requirement> <relatedData value="[string]"/><!--
0..1 What data is provided --> </output> <relatedAction>
0..* BackboneElement <!--
0..* Relationship to another action --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<targetId value="[id]"/><!--1..1 What action is this related to --> <relationship value="[code]"/><!--
1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <offset[x]><!--
0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction>
<| </timing[x]> <<timing[x]><!--0..1 Age|Duration|Range|Timing When the action should take place --></timing[x]> <location><!--
0..1 CodeableReference Where it should happen --></location> <participant>
0..* BackboneElement <!--
0..* Who should participate in the action --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
< <</role><actorId value="[string]"/><!--0..1 What actor --> <type value="[code]"/><!--
0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeReference><!--
0..1 Reference(CareTeam) Who or what can participate --></typeReference> <role><!--
0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
--></role> <function><!--
0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function> </participant> <type><!--
0..1 CodeableConcept create | update | remove | fire-event --></type> <groupingBehavior value="[code]"/><!--
0..1 visual-group | logical-group | sentence-group --> <selectionBehavior value="[code]"/><!--
0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more --> <requiredBehavior value="[code]"/><!--
0..1 must | could | must-unless-documented --> <precheckBehavior value="[code]"/><!--
0..1 yes | no --> <cardinalityBehavior value="[code]"/><!--
0..1 single | multiple -->
<<definition[x]><!--0..1 canonical|uri Description of the activity to be performed --></definition[x]> <transform value="[canonical]"/><!--
0..1 Transform to apply the template -->
<<dynamicValue>0..* BackboneElement <!--
0..* Dynamic aspects of the definition --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<path value="[string]"/><!--0..1 The path to the element to be set dynamically --> <expression><!--
0..1 Expression An expression that provides the dynamic value for the customization --></expression> </dynamicValue>
<</action><action><!-- See http://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action A sub-action --></action> </action> </PlanDefinition>
JSON Template
{ // Computable PlanDefinition
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C?Canonical identifier for this plan definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the plan definition
"version" : "<string>", // C?Business version of the plan definition
"name" : "<string>", // C?Name for this plan definition (computer friendly)
"title" : "<string>", // C?Name for this plan definition (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the plan definition
"type" : { CodeableConcept }, // C?order-set | clinical-protocol | eca-rule | workflow-definition
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C?For testing purposes, not real usage
"
"
// value[x]: Type of individual the plan definition is focused on. One of these 3:
"subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the plan definition is focused on
"subjectReference" : { Reference(Group) }, // C?Type of individual the plan definition is focused on
"subjectCanonical" : "<canonical>", // C?Type of individual the plan definition is focused on
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C?Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C?Natural language description of the plan definition
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for plan definition (if applicable)
"purpose" : "<markdown>", // C?Why this plan definition is defined
"usage" : "<string>", // C?Describes the clinical usage of the plan
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the plan definition was approved by publisher
"lastReviewDate" : "<date>", // C?When the plan definition was last reviewed
"effectivePeriod" : { Period }, // C?When the plan definition is expected to be used
"topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations
"library" : "<canonical>", // C? R! Logic used by the plan definition
"
"
"goal" : [{ BackboneElement }] // C?What the plan is trying to accomplish
"actor" : [{ BackboneElement }], // C?Actors within the plan
"action" : [{ BackboneElement }], // C?Action defined by the plan
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| PlanDefinition.language | Common Languages | preferred | Common Languages |
| PlanDefinition.type | PlanDefinitionType | extensible | PlanDefinitionType |
| PlanDefinition.status | PublicationStatus | required | PublicationStatus |
| PlanDefinition.subject[x] | Subject type | extensible | Subject type |
| PlanDefinition.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| PlanDefinition.topic | DefinitionTopic | example | DefinitionTopic |
| PlanDefinition.goal.category |
|
example |
|
| PlanDefinition.goal.description | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
| PlanDefinition.goal.priority |
|
preferred |
|
| PlanDefinition.goal.start |
|
example |
|
| PlanDefinition.goal.addresses | Condition/Problem/Diagnosis Codes | example | Condition/Problem/Diagnosis Codes |
| PlanDefinition.goal.target.measure | LOINC Codes | example | LOINC Codes |
| PlanDefinition.actor.option.type | ActionParticipantType | required | ActionParticipantType |
| PlanDefinition.actor.option.role | ActionParticipantRole | example |
ActionParticipantRole
![]() |
| PlanDefinition.action.priority |
|
required |
|
| PlanDefinition.action.code | ActionCode | example | ActionCode |
| PlanDefinition.action.reason | ActionReasonCode | example | ActionReasonCode |
| PlanDefinition.action.subject[x] | Subject type | extensible | Subject type |
| PlanDefinition.action.condition.kind | ActionConditionKind | required | ActionConditionKind |
| PlanDefinition.action.relatedAction.relationship | ActionRelationshipType | required | ActionRelationshipType |
| PlanDefinition.action.participant.type | ActionParticipantType | required | ActionParticipantType |
| PlanDefinition.action.participant.role |
|
example |
![]() |
| PlanDefinition.action.participant.function | ActionParticipantFunction | example | ActionParticipantFunction |
| PlanDefinition.action.type | ActionType | extensible | ActionType |
| PlanDefinition.action.groupingBehavior | ActionGroupingBehavior | required | ActionGroupingBehavior |
| PlanDefinition.action.selectionBehavior | ActionSelectionBehavior | required | ActionSelectionBehavior |
| PlanDefinition.action.requiredBehavior | ActionRequiredBehavior | required | ActionRequiredBehavior |
| PlanDefinition.action.precheckBehavior | ActionPrecheckBehavior | required | ActionPrecheckBehavior |
| PlanDefinition.action.cardinalityBehavior | ActionCardinalityBehavior | required | ActionCardinalityBehavior |