This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Clinical
Decision
Support
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/publishableplandefinition
Supports declaration of the PlanDefinition metadata required by HL7 and other organizations that share and publish plandefinitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management
implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This
profile
was
published
on
Thu,
Jan
1,
1970
00:00+1000
00:00+0800
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from ShareablePlanDefinition .
Summary
Mandatory:
1
element
Must-Support:
22
elements
This indicates the differences between this profile and the base ShareablePlanDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareablePlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
|
S | 0 .. * | Identifier | Additional identifier for the plan definition |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for plan definition (if applicable) |
|
S | 0 .. 1 | markdown | Why this plan definition is defined |
|
S | 0 .. 1 | markdown | Describes the clinical usage of the plan |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
S | 0 .. 1 | date | When the plan definition was approved by publisher |
|
S | 0 .. 1 | date | When the plan definition was last reviewed by the publisher |
|
S | 0 .. 1 | Period | When the plan definition is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment |
|
S | 0 .. * | ContactDetail | Who authored the content |
|
S | 0 .. * | ContactDetail | Who edited the content |
|
S | 0 .. * | ContactDetail | Who reviewed the content |
|
S | 0 .. * | ContactDetail | Who endorsed the content |
|
S | 0 .. * | RelatedArtifact | Additional documentation, citations |
|
S | 0 .. 1 | string | Brief description of the related artifact |
|
S | 0 .. 1 | Attachment | What document is being referenced |
|
S | 0 .. 1 | canonical ( Resource ) | What artifact is being referenced |
|
S | 0 .. 1 | Reference ( Resource ) | What artifact, if not a conformance resource |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareablePlanDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareablePlanDefinition |
The
definition
of
a
plan
for
a
series
of
actions,
independent
of
any
specific
patient
or
context
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation pld-3: goalid should reference the id of a goal definition pld-4: targetId should reference the id of an action |
||||
|
Σ | 0..1 | id | 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: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set ( required ) |
||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
plan
definition,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
plan
definition
|
||||
|
S Σ | 1..1 | string | Business version of the plan definition | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this plan definition (computer friendly) | ||||
|
S Σ | 1..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: Plan Definition Type ( extensible ): The type of PlanDefinition. |
||||
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
|
0..1 |
Type
of
individual
the
plan
definition
is
focused
on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||||||
|
canonical ( EvidenceVariable ) | |||||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
S Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
plan
definition
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
S | 0..1 | markdown | Why this plan definition is defined | ||||
|
S | 0..1 | markdown | Describes the clinical usage of the plan | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
S | 0..1 | date | When the plan definition was approved by publisher | ||||
|
S | 0..1 | date | When the plan definition was last reviewed by the publisher | ||||
|
S Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment
Binding: Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering. |
||||
|
S | 0..* | ContactDetail |
Who
authored
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
edited
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
reviewed
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
endorsed
the
content
|
||||
|
S | 0..* | RelatedArtifact |
Additional
documentation,
citations
|
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
|
1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact. |
||||
|
|
0..* | CodeableConcept |
Additional
classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact. |
||||
|
|
0..1 | string | Short label | ||||
|
S
|
0..1 | string | Brief description of the related artifact | ||||
|
|
0..1 | markdown | Bibliographic citation for the artifact | ||||
|
S
|
0..1 | Attachment | What document is being referenced | ||||
|
S
|
0..1 | canonical ( Resource ) | What artifact is being referenced | ||||
|
S
|
0..1 | Reference ( Resource ) | What artifact, if not a conformance resource | ||||
|
|
0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): Publication status of an artifact being referred to. |
||||
|
|
0..1 | date | Date of publication of the artifact being referred to | ||||
|
0..* | canonical ( Library ) |
Logic
used
by
the
plan
definition
|
|||||
|
C
|
0..* | BackboneElement |
What
the
plan
is
trying
to
accomplish
|
||||
|
0..1 | string | 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: Goal Category ( example ): Example codes for grouping goals for filtering or presentation. |
|||||
|
1..1 | CodeableConcept |
Code
or
text
describing
the
goal
Binding: SNOMED CT Clinical Findings ( example ): Describes goals that can be achieved. |
|||||
|
0..1 | CodeableConcept |
high-priority
|
medium-priority
|
low-priority
Binding: Goal Priority ( preferred ): Indicates the level of importance associated with reaching or sustaining a goal. |
|||||
|
0..1 | CodeableConcept |
When
goal
pursuit
begins
Binding: Goal Start Event ( example ): Identifies the types of events that might trigger the start of a goal. |
|||||
|
0..* | CodeableConcept |
What
does
the
goal
address
Binding: Condition/Problem/Diagnosis Codes ( example ): Identifies problems, conditions, issues, or concerns that goals may address. |
|||||
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
goal
|
|||||
|
0..* | BackboneElement |
Target
outcome
for
the
goal
|
|||||
|
0..1 | string | 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 ): Identifies types of parameters that can be tracked to determine goal achievement. |
|||||
|
0..1 | The target value to be achieved | ||||||
|
Quantity | |||||||
|
Range | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
Ratio | |||||||
|
0..1 | Duration | Reach goal within | |||||
|
0..* | BackboneElement |
Actors
within
the
plan
|
|||||
|
0..1 | string | 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 | markdown | Describes the actor | |||||
|
1..* | BackboneElement |
Who
or
what
can
be
this
actor
|
|||||
|
0..1 | string | 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: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: Action Participant Role
(
example
)
|
|||||
|
C
|
0..* | BackboneElement |
Action
defined
by
the
plan
|
||||
|
0..1 | string | 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 | Unique id for the action in the PlanDefinition | |||||
|
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
|
0..1 | string | User-visible title | |||||
|
0..1 | markdown | Brief description of the action | |||||
|
0..1 | markdown | 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: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
|||||
|
0..1 | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: Action Code ( example ): Provides examples of actions to be performed. |
|||||
|
0..* | CodeableConcept |
Why
the
action
should
be
performed
Binding: Action Reason Code ( example ): Provides examples of reasons for actions to be performed. |
|||||
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|||||
|
C
|
0..* | id |
What
goals
this
action
supports
|
||||
|
0..1 |
Type
of
individual
the
action
is
focused
on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group ) | |||||||
|
canonical (Any) | |||||||
|
0..* | TriggerDefinition |
When
the
action
should
be
triggered
|
|||||
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|||||
|
0..1 | string | 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: Action Condition Kind ( required ): Defines the kinds of conditions that can appear on actions. |
|||||
|
0..1 | Expression | Boolean-valued expression | |||||
|
C
|
0..* | BackboneElement |
Input
data
requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | 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 | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | id | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Output
data
definition
pld-1: Output data element must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | 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 | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | string | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Relationship
to
another
action
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
|
1..1 | id | What action is this related to | ||||
|
1..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | Time offset for the relationship | ||||||
|
Duration | |||||||
|
Range | |||||||
|
0..1 | When the action should take place | ||||||
|
Age | |||||||
|
Duration | |||||||
|
Range | |||||||
|
Timing | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|||||
|
0..1 | string | 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 | |||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: Action Type ( extensible ): The type of action to be performed. |
|||||
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: Action Grouping Behavior ( required ): Defines organization behavior of a group. |
|||||
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: Action Selection Behavior ( required ): Defines selection behavior of a group. |
|||||
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: Action Required Behavior ( required ): Defines expectations around whether an action or action group is required. |
|||||
|
0..1 | code |
yes
|
no
Binding: Action Precheck Behavior ( required ): Defines selection frequency behavior for an action or group. |
|||||
|
0..1 | code |
single
|
multiple
Binding: Action Cardinality Behavior ( required ): Defines behavior for an action or a group for how many times that item may be repeated. |
|||||
|
0..1 | Description of the activity to be performed | ||||||
|
canonical ( ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition ) | |||||||
|
uri | |||||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | 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) |
A
sub-action
|
|||||
|
Σ | 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. |
|||||
|
boolean | |||||||
|
CodeableConcept | |||||||
|
||||||||
<!-- PublishablePlanDefinition --><PlanDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <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><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishableplandefinition-definitions.html#PlanDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this plan definition, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the plan definition --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the plan definition --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this plan definition (computer friendly) --> <title value="[string]"/><!-- I 1..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 1..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 1..1 Natural language description of the plan definition --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <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="[markdown]"/><!-- I 0..1 Describes the clinical usage of the plan --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <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 by the publisher --> <effectivePeriod><!-- I 0..1 Period When the plan definition is expected to be used --></effectivePeriod> <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 <!-- I 0..* Additional documentation, citations --> <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as --> <classifier><!-- I 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- I 0..1 Short label --> <display value="[string]"/><!-- I 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact --> <document><!-- I 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced --> <resourceReference><!-- I 0..1 Reference(Resource) What artifact, if not a conformance resource --></resourceReference> <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown --> <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to --> </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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.goal.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.goal.target.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.actor.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.actor.option.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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><role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent--></role> </option> </actor> <action> I 0..* BackboneElement <!-- I 0..* Action defined by the plan -->
<<a href="publishableplandefinition-definitions.html#PlanDefinition.action.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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="[markdown]"/><!-- I 0..1 Brief description of the action --> <textEquivalent value="[markdown]"/><!-- I 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <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> <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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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> I 0..* BackboneElement <!-- I 0..* Input data requirements --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.input.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.output.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.relatedAction.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <endRelationship value="[code]"/><!-- I 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <offset[x]><!-- I 0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction> <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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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><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><!-- 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 -->
<<a href="publishableplandefinition-definitions.html#PlanDefinition.action.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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>
{ // PublishablePlanDefinition
// 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
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"<a href="publishableplandefinition-definitions.html#PlanDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this plan definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the plan definition
"version" : "<string>", // I R! Business version of the plan definition
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this plan definition (computer friendly)
"title" : "<string>", // I R! Name 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>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural 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" : "<markdown>", // IDescribes the clinical usage of the plan
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the plan definition was approved by publisher
"lastReviewDate" : "<date>", // IWhen the plan definition was last reviewed by the publisher
"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
}
This structure is derived from ShareablePlanDefinition .
Differential View
This indicates the differences between this profile and the base ShareablePlanDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareablePlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
|
S | 0 .. * | Identifier | Additional identifier for the plan definition |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for plan definition (if applicable) |
|
S | 0 .. 1 | markdown | Why this plan definition is defined |
|
S | 0 .. 1 | markdown | Describes the clinical usage of the plan |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
S | 0 .. 1 | date | When the plan definition was approved by publisher |
|
S | 0 .. 1 | date | When the plan definition was last reviewed by the publisher |
|
S | 0 .. 1 | Period | When the plan definition is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment |
|
S | 0 .. * | ContactDetail | Who authored the content |
|
S | 0 .. * | ContactDetail | Who edited the content |
|
S | 0 .. * | ContactDetail | Who reviewed the content |
|
S | 0 .. * | ContactDetail | Who endorsed the content |
|
S | 0 .. * | RelatedArtifact | Additional documentation, citations |
|
S | 0 .. 1 | string | Brief description of the related artifact |
|
S | 0 .. 1 | Attachment | What document is being referenced |
|
S | 0 .. 1 | canonical ( Resource ) | What artifact is being referenced |
|
S | 0 .. 1 | Reference ( Resource ) | What artifact, if not a conformance resource |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareablePlanDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareablePlanDefinition |
The
definition
of
a
plan
for
a
series
of
actions,
independent
of
any
specific
patient
or
context
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation pld-3: goalid should reference the id of a goal definition pld-4: targetId should reference the id of an action |
||||
|
Σ | 0..1 | id | 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: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set ( required ) |
||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
plan
definition,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
plan
definition
|
||||
|
S Σ | 1..1 | string | Business version of the plan definition | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this plan definition (computer friendly) | ||||
|
S Σ | 1..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: Plan Definition Type ( extensible ): The type of PlanDefinition. |
||||
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
|
0..1 |
Type
of
individual
the
plan
definition
is
focused
on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||||||
|
canonical ( EvidenceVariable ) | |||||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
S Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
plan
definition
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
S | 0..1 | markdown | Why this plan definition is defined | ||||
|
S | 0..1 | markdown | Describes the clinical usage of the plan | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
S | 0..1 | date | When the plan definition was approved by publisher | ||||
|
S | 0..1 | date | When the plan definition was last reviewed by the publisher | ||||
|
S Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment
Binding: Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering. |
||||
|
S | 0..* | ContactDetail |
Who
authored
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
edited
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
reviewed
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
endorsed
the
content
|
||||
|
S | 0..* | RelatedArtifact |
Additional
documentation,
citations
|
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
|
1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact. |
||||
|
|
0..* | CodeableConcept |
Additional
classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact. |
||||
|
|
0..1 | string | Short label | ||||
|
S
|
0..1 | string | Brief description of the related artifact | ||||
|
|
0..1 | markdown | Bibliographic citation for the artifact | ||||
|
S
|
0..1 | Attachment | What document is being referenced | ||||
|
S
|
0..1 | canonical ( Resource ) | What artifact is being referenced | ||||
|
S
|
0..1 | Reference ( Resource ) | What artifact, if not a conformance resource | ||||
|
|
0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): Publication status of an artifact being referred to. |
||||
|
|
0..1 | date | Date of publication of the artifact being referred to | ||||
|
0..* | canonical ( Library ) |
Logic
used
by
the
plan
definition
|
|||||
|
C
|
0..* | BackboneElement |
What
the
plan
is
trying
to
accomplish
|
||||
|
0..1 | string | 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: Goal Category ( example ): Example codes for grouping goals for filtering or presentation. |
|||||
|
1..1 | CodeableConcept |
Code
or
text
describing
the
goal
Binding: SNOMED CT Clinical Findings ( example ): Describes goals that can be achieved. |
|||||
|
0..1 | CodeableConcept |
high-priority
|
medium-priority
|
low-priority
Binding: Goal Priority ( preferred ): Indicates the level of importance associated with reaching or sustaining a goal. |
|||||
|
0..1 | CodeableConcept |
When
goal
pursuit
begins
Binding: Goal Start Event ( example ): Identifies the types of events that might trigger the start of a goal. |
|||||
|
0..* | CodeableConcept |
What
does
the
goal
address
Binding: Condition/Problem/Diagnosis Codes ( example ): Identifies problems, conditions, issues, or concerns that goals may address. |
|||||
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
goal
|
|||||
|
0..* | BackboneElement |
Target
outcome
for
the
goal
|
|||||
|
0..1 | string | 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 ): Identifies types of parameters that can be tracked to determine goal achievement. |
|||||
|
0..1 | The target value to be achieved | ||||||
|
Quantity | |||||||
|
Range | |||||||
|
CodeableConcept | |||||||
|
string | |||||||
|
boolean | |||||||
|
integer | |||||||
|
Ratio | |||||||
|
0..1 | Duration | Reach goal within | |||||
|
0..* | BackboneElement |
Actors
within
the
plan
|
|||||
|
0..1 | string | 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 | markdown | Describes the actor | |||||
|
1..* | BackboneElement |
Who
or
what
can
be
this
actor
|
|||||
|
0..1 | string | 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: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: Action Participant Role
(
example
)
|
|||||
|
C
|
0..* | BackboneElement |
Action
defined
by
the
plan
|
||||
|
0..1 | string | 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 | Unique id for the action in the PlanDefinition | |||||
|
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
|
0..1 | string | User-visible title | |||||
|
0..1 | markdown | Brief description of the action | |||||
|
0..1 | markdown | 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: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
|||||
|
0..1 | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: Action Code ( example ): Provides examples of actions to be performed. |
|||||
|
0..* | CodeableConcept |
Why
the
action
should
be
performed
Binding: Action Reason Code ( example ): Provides examples of reasons for actions to be performed. |
|||||
|
0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
|||||
|
C
|
0..* | id |
What
goals
this
action
supports
|
||||
|
0..1 |
Type
of
individual
the
action
is
focused
on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group ) | |||||||
|
canonical (Any) | |||||||
|
0..* | TriggerDefinition |
When
the
action
should
be
triggered
|
|||||
|
0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
|||||
|
0..1 | string | 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: Action Condition Kind ( required ): Defines the kinds of conditions that can appear on actions. |
|||||
|
0..1 | Expression | Boolean-valued expression | |||||
|
C
|
0..* | BackboneElement |
Input
data
requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | 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 | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | id | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Output
data
definition
pld-1: Output data element must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | 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 | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | string | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Relationship
to
another
action
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
|
1..1 | id | What action is this related to | ||||
|
1..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | Time offset for the relationship | ||||||
|
Duration | |||||||
|
Range | |||||||
|
0..1 | When the action should take place | ||||||
|
Age | |||||||
|
Duration | |||||||
|
Range | |||||||
|
Timing | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|||||
|
0..1 | string | 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 | |||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: Action Type ( extensible ): The type of action to be performed. |
|||||
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: Action Grouping Behavior ( required ): Defines organization behavior of a group. |
|||||
|
0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: Action Selection Behavior ( required ): Defines selection behavior of a group. |
|||||
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: Action Required Behavior ( required ): Defines expectations around whether an action or action group is required. |
|||||
|
0..1 | code |
yes
|
no
Binding: Action Precheck Behavior ( required ): Defines selection frequency behavior for an action or group. |
|||||
|
0..1 | code |
single
|
multiple
Binding: Action Cardinality Behavior ( required ): Defines behavior for an action or a group for how many times that item may be repeated. |
|||||
|
0..1 | Description of the activity to be performed | ||||||
|
canonical ( ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition ) | |||||||
|
uri | |||||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | 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) |
A
sub-action
|
|||||
|
Σ | 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. |
|||||
|
boolean | |||||||
|
CodeableConcept | |||||||
|
||||||||
XML Template
<!-- PublishablePlanDefinition --><PlanDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <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><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishableplandefinition-definitions.html#PlanDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this plan definition, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the plan definition --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the plan definition --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this plan definition (computer friendly) --> <title value="[string]"/><!-- I 1..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 1..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 1..1 Natural language description of the plan definition --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <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="[markdown]"/><!-- I 0..1 Describes the clinical usage of the plan --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <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 by the publisher --> <effectivePeriod><!-- I 0..1 Period When the plan definition is expected to be used --></effectivePeriod> <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 <!-- I 0..* Additional documentation, citations --> <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as --> <classifier><!-- I 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- I 0..1 Short label --> <display value="[string]"/><!-- I 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact --> <document><!-- I 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced --> <resourceReference><!-- I 0..1 Reference(Resource) What artifact, if not a conformance resource --></resourceReference> <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown --> <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to --> </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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.goal.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.goal.target.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.actor.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.actor.option.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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><role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent--></role> </option> </actor> <action> I 0..* BackboneElement <!-- I 0..* Action defined by the plan -->
<<a href="publishableplandefinition-definitions.html#PlanDefinition.action.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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="[markdown]"/><!-- I 0..1 Brief description of the action --> <textEquivalent value="[markdown]"/><!-- I 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <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> <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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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> I 0..* BackboneElement <!-- I 0..* Input data requirements --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.input.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.output.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.relatedAction.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <endRelationship value="[code]"/><!-- I 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <offset[x]><!-- I 0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction> <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 --><<a href="publishableplandefinition-definitions.html#PlanDefinition.action.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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><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><!-- 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 -->
<<a href="publishableplandefinition-definitions.html#PlanDefinition.action.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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>
JSON Template
{ // PublishablePlanDefinition
// 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
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"<a href="publishableplandefinition-definitions.html#PlanDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this plan definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the plan definition
"version" : "<string>", // I R! Business version of the plan definition
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this plan definition (computer friendly)
"title" : "<string>", // I R! Name 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>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural 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" : "<markdown>", // IDescribes the clinical usage of the plan
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the plan definition was approved by publisher
"lastReviewDate" : "<date>", // IWhen the plan definition was last reviewed by the publisher
"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
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| PlanDefinition.language | All Languages | required | All Languages |
| PlanDefinition.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| PlanDefinition.type | Plan Definition Type | extensible | Plan Definition Type |
| PlanDefinition.status | PublicationStatus | required | PublicationStatus |
| PlanDefinition.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
| PlanDefinition.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| PlanDefinition.topic | Definition Topic | example | Definition Topic |
| PlanDefinition.relatedArtifact.type | RelatedArtifactType | required | RelatedArtifactType |
| PlanDefinition.relatedArtifact.classifier | Citation Artifact Classifier | example | Citation Artifact Classifier |
| PlanDefinition.relatedArtifact.publicationStatus | PublicationStatus | required | PublicationStatus |
| PlanDefinition.goal.category | Goal Category | example | Goal Category |
| PlanDefinition.goal.description | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
| PlanDefinition.goal.priority | Goal Priority | preferred | Goal Priority |
| PlanDefinition.goal.start | Goal Start Event | example | Goal Start Event |
| 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 | Action Participant Type | required | Action Participant Type |
| PlanDefinition.actor.option.role | Action Participant Role | example |
Action
Participant
Role
|
| PlanDefinition.action.priority | RequestPriority | required | RequestPriority |
| PlanDefinition.action.code | Action Code | example | Action Code |
| PlanDefinition.action.reason | Action Reason Code | example | Action Reason Code |
| PlanDefinition.action.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
| PlanDefinition.action.condition.kind | Action Condition Kind | required | Action Condition Kind |
| PlanDefinition.action.relatedAction.relationship | Action Relationship Type | required | Action Relationship Type |
| PlanDefinition.action.relatedAction.endRelationship | Action Relationship Type | required | Action Relationship Type |
| PlanDefinition.action.participant.type | Action Participant Type | required | Action Participant Type |
| PlanDefinition.action.participant.role | Action Participant Role | example |
Action
Participant
Role
|
| PlanDefinition.action.participant.function | Action Participant Function | example | Action Participant Function |
| PlanDefinition.action.type | Action Type | extensible | Action Type |
| PlanDefinition.action.groupingBehavior | Action Grouping Behavior | required | Action Grouping Behavior |
| PlanDefinition.action.selectionBehavior | Action Selection Behavior | required | Action Selection Behavior |
| PlanDefinition.action.requiredBehavior | Action Required Behavior | required | Action Required Behavior |
| PlanDefinition.action.precheckBehavior | Action Precheck Behavior | required | Action Precheck Behavior |
| PlanDefinition.action.cardinalityBehavior | Action Cardinality Behavior | required | Action Cardinality Behavior |
| PlanDefinition.asNeeded[x] | SNOMED CT Medication As Needed Reason Codes | example | SNOMED CT Medication As Needed Reason Codes |