Clinical Practice Guidelines (CPG) on EBMonFHIR
1.0.1 - ci-build
Clinical Practice Guidelines (CPG) on EBMonFHIR, published by Universitätsmedizin Greifswald. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CEOsys/cpg-on-ebm-on-fhir/ and changes regularly. See the Directory of published versions
Draft as of 2022-12-08 |
Definitions for the recommendation-plan resource profile.
Guidance on how to interpret the contents of this table can be found here
0. PlanDefinition | |
Invariants | selection-behavior-unique-or-no-value: If selectionBehavior is present, it must be the same for all actions in the group (action.selectionBehavior.distinct().count() <= 1 )nested-action-requires-combination-method: If a nested action is present, a combination method must be present. ( action.exists() implies extension('https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method').exists() ) |
2. PlanDefinition.meta | |
Control | 1..? |
Must Support | true |
4. PlanDefinition.meta.source | |
Must Support | true |
6. PlanDefinition.meta.profile | |
Control | 1..? |
Must Support | true |
8. PlanDefinition.extension | |
Control | 4..? |
10. PlanDefinition.extension:knowledgeCapability | |
Slice Name | knowledgeCapability |
Control | 1..1 |
12. PlanDefinition.extension:knowledgeCapability.extension | |
Control | 0..0 |
14. PlanDefinition.extension:knowledgeCapability.value[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Pattern Value | computable |
16. PlanDefinition.extension:knowledgeRepresentationLevel | |
Slice Name | knowledgeRepresentationLevel |
Control | 1..1 |
18. PlanDefinition.extension:knowledgeRepresentationLevel.extension | |
Control | 0..0 |
20. PlanDefinition.extension:knowledgeRepresentationLevel.value[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Pattern Value | structured |
22. PlanDefinition.extension:partOf | |
Slice Name | partOf |
Control | 1..? |
24. PlanDefinition.extension:partOf.extension | |
Control | 0..0 |
26. PlanDefinition.extension:partOf.value[x] | |
Control | 1..? |
Type | canonical(Recommendation) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
28. PlanDefinition.extension:combinationMethod | |
Slice Name | combinationMethod |
Control | 1..1 |
Type | Extension(Action Combination Method) (Complex Extension) |
Must Support | true |
30. PlanDefinition.name | |
Control | 1..? |
32. PlanDefinition.subject[x] | |
Control | 1..? |
Type | canonical(Recommendation Eligibility Criteria), Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. PlanDefinition.date | |
Control | 1..? |
36. PlanDefinition.goal | |
Must Support | true |
Slicing | This element introduces a set of slices on PlanDefinition.goal . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
38. PlanDefinition.goal.id | |
Control | 1..? |
Must Support | true |
40. PlanDefinition.goal.category | |
Control | 1..? |
Must Support | true |
42. PlanDefinition.goal.category.coding | |
Control | 1..? |
44. PlanDefinition.goal.category.coding.system | |
Control | 1..? |
46. PlanDefinition.goal.category.coding.code | |
Control | 1..? |
48. PlanDefinition.goal:ventilatorManagement | |
Slice Name | ventilatorManagement |
Control | 0..* |
50. PlanDefinition.goal:ventilatorManagement.category | |
Pattern Value | { |
52. PlanDefinition.goal:ventilatorManagement.target | |
Control | 1..? |
54. PlanDefinition.goal:ventilatorManagement.target.measure | |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from VS MII ICU Code Observation Beatmung [LOINC] (extensible to https://www.medizininformatik-initiative.de/fhir/ext/modul-icu/ValueSet/Code-Observation-Beatmung-LOINC ) |
Must Support | true |
56. PlanDefinition.goal:ventilatorManagement.target.detail[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
58. PlanDefinition.goal:laboratoryValue | |
Slice Name | laboratoryValue |
Control | 0..* |
60. PlanDefinition.goal:laboratoryValue.category | |
Pattern Value | { |
62. PlanDefinition.goal:laboratoryValue.target | |
Control | 1..? |
64. PlanDefinition.goal:laboratoryValue.target.measure | |
Control | 1..? |
Must Support | true |
66. PlanDefinition.goal:laboratoryValue.target.measure.coding | |
Pattern Value | { |
68. PlanDefinition.goal:laboratoryValue.target.measure.coding.system | |
Control | 1..? |
Must Support | true |
70. PlanDefinition.goal:laboratoryValue.target.measure.coding.code | |
Control | 1..? |
Must Support | true |
72. PlanDefinition.goal:laboratoryValue.target.detail[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
74. PlanDefinition.goal:assessmentScale | |
Slice Name | assessmentScale |
Control | 0..* |
76. PlanDefinition.goal:assessmentScale.category | |
Pattern Value | { |
78. PlanDefinition.goal:assessmentScale.target | |
Control | 1..? |
80. PlanDefinition.goal:assessmentScale.target.measure | |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from Assessment Scales (extensible to https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/ValueSet/vs-assessment-scales ) |
Must Support | true |
82. PlanDefinition.goal:assessmentScale.target.detail[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
84. PlanDefinition.goal:other | |
Slice Name | other |
Control | 0..* |
86. PlanDefinition.goal:other.category | |
Pattern Value | { |
88. PlanDefinition.goal:other.target | |
Control | 1..? |
90. PlanDefinition.goal:other.target.measure | |
Control | 1..? |
Must Support | true |
92. PlanDefinition.goal:other.target.detail[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
94. PlanDefinition.action | |
Slicing | This element introduces a set of slices on PlanDefinition.action . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
96. PlanDefinition.action.code | |
Control | 1..? |
98. PlanDefinition.action.code.coding | |
Control | 1..? |
100. PlanDefinition.action.code.coding.system | |
Control | 1..? |
102. PlanDefinition.action.code.coding.code | |
Control | 1..? |
104. PlanDefinition.action.timing[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on PlanDefinition.action.timing[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
106. PlanDefinition.action.timing[x]:timingTiming | |
Slice Name | timingTiming |
Control | 0..1 |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
108. PlanDefinition.action.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
110. PlanDefinition.action:combination | |
Slice Name | combination |
Control | 0..* |
Invariants | nested-action-requires-combination-method: If a nested action is present, a combination method must be present. (action.exists() implies extension('https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method').exists() ) |
112. PlanDefinition.action:combination.extension | |
Control | 1..? |
114. PlanDefinition.action:combination.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
116. PlanDefinition.action:combination.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
118. PlanDefinition.action:combination.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
120. PlanDefinition.action:combination.extension:combinationMethod | |
Slice Name | combinationMethod |
Control | 1..1 |
Type | Extension(Action Combination Method) (Complex Extension) |
Must Support | true |
122. PlanDefinition.action:combination.code | |
Pattern Value | { |
124. PlanDefinition.action:combination.goalId | |
Control | 0..0 |
126. PlanDefinition.action:combination.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
128. PlanDefinition.action:combination.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
130. PlanDefinition.action:combination.definition[x] | |
Control | 0..0 |
132. PlanDefinition.action:combination.action | |
Control | 1..? |
Type | BackboneElement |
Slicing | This element introduces a set of slices on PlanDefinition.action.action . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
134. PlanDefinition.action:combination.action.code | |
Control | 1..? |
Must Support | true |
136. PlanDefinition.action:combination.action.code.coding | |
Control | 1..? |
138. PlanDefinition.action:combination.action.code.coding.system | |
Control | 1..? |
140. PlanDefinition.action:combination.action.code.coding.code | |
Control | 1..? |
142. PlanDefinition.action:combination.action.timing[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on PlanDefinition.action.action.timing[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
144. PlanDefinition.action:combination.action.timing[x]:timingTiming | |
Slice Name | timingTiming |
Control | 0..1 |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
146. PlanDefinition.action:combination.action.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
148. PlanDefinition.action:combination.action:combination | |
Slice Name | combination |
Control | 0..* |
Type | BackboneElement |
150. PlanDefinition.action:combination.action:combination.code | |
Control | 1..? |
Pattern Value | { |
152. PlanDefinition.action:combination.action:combination.goalId | |
Control | 0..0 |
154. PlanDefinition.action:combination.action:combination.definition[x] | |
Control | 0..0 |
156. PlanDefinition.action:combination.action:combination.action | |
Control | 1..? |
Must Support | true |
158. PlanDefinition.action:combination.action:drugAdministration | |
Slice Name | drugAdministration |
Control | 0..* |
Type | BackboneElement |
160. PlanDefinition.action:combination.action:drugAdministration.code | |
Control | 1..? |
Pattern Value | { |
162. PlanDefinition.action:combination.action:drugAdministration.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
164. PlanDefinition.action:combination.action:drugAdministration.definition[x] | |
Type | canonical(Drug Administration Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
166. PlanDefinition.action:combination.action:ventilatorManagement | |
Slice Name | ventilatorManagement |
Control | 0..* |
Type | BackboneElement |
168. PlanDefinition.action:combination.action:ventilatorManagement.code | |
Control | 1..? |
Pattern Value | { |
170. PlanDefinition.action:combination.action:ventilatorManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
172. PlanDefinition.action:combination.action:ventilatorManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
174. PlanDefinition.action:combination.action:bodyPositioning | |
Slice Name | bodyPositioning |
Control | 0..* |
Type | BackboneElement |
176. PlanDefinition.action:combination.action:bodyPositioning.code | |
Control | 1..? |
Pattern Value | { |
178. PlanDefinition.action:combination.action:bodyPositioning.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
180. PlanDefinition.action:combination.action:bodyPositioning.definition[x] | |
Type | canonical(Body Positioning Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
182. PlanDefinition.action:combination.action:sedationManagement | |
Slice Name | sedationManagement |
Control | 0..* |
Type | BackboneElement |
184. PlanDefinition.action:combination.action:sedationManagement.code | |
Control | 1..? |
Pattern Value | { |
186. PlanDefinition.action:combination.action:sedationManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
188. PlanDefinition.action:combination.action:sedationManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
190. PlanDefinition.action:combination.action:painManagement | |
Slice Name | painManagement |
Control | 0..* |
Type | BackboneElement |
192. PlanDefinition.action:combination.action:painManagement.code | |
Control | 1..? |
Pattern Value | { |
194. PlanDefinition.action:combination.action:painManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
196. PlanDefinition.action:combination.action:painManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
198. PlanDefinition.action:combination.action:assessment | |
Slice Name | assessment |
Control | 0..* |
Type | BackboneElement |
200. PlanDefinition.action:combination.action:assessment.code | |
Control | 1..? |
Pattern Value | { |
202. PlanDefinition.action:combination.action:assessment.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
204. PlanDefinition.action:combination.action:assessment.definition[x] | |
Type | canonical(Assessment Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
206. PlanDefinition.action:combination.action:procedure | |
Slice Name | procedure |
Control | 0..* |
Type | BackboneElement |
208. PlanDefinition.action:combination.action:procedure.code | |
Control | 1..? |
Pattern Value | { |
210. PlanDefinition.action:combination.action:procedure.definition[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on PlanDefinition.action.action.definition[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
212. PlanDefinition.action:combination.action:procedure.definition[x]:definitionCanonical | |
Slice Name | definitionCanonical |
Control | 0..1 |
Type | canonical(Procedure Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
214. PlanDefinition.action:combination.action:other | |
Slice Name | other |
Control | 0..* |
Type | BackboneElement |
216. PlanDefinition.action:combination.action:other.code | |
Control | 1..? |
Pattern Value | { |
218. PlanDefinition.action:combination.action:other.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
220. PlanDefinition.action:combination.action:other.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
222. PlanDefinition.action:drugAdministration | |
Slice Name | drugAdministration |
Control | 0..* |
224. PlanDefinition.action:drugAdministration.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
226. PlanDefinition.action:drugAdministration.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
228. PlanDefinition.action:drugAdministration.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
230. PlanDefinition.action:drugAdministration.code | |
Pattern Value | { |
232. PlanDefinition.action:drugAdministration.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
234. PlanDefinition.action:drugAdministration.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
236. PlanDefinition.action:drugAdministration.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
238. PlanDefinition.action:drugAdministration.definition[x] | |
Type | canonical(Drug Administration Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
240. PlanDefinition.action:ventilatorManagement | |
Slice Name | ventilatorManagement |
Control | 0..* |
242. PlanDefinition.action:ventilatorManagement.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
244. PlanDefinition.action:ventilatorManagement.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
246. PlanDefinition.action:ventilatorManagement.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
248. PlanDefinition.action:ventilatorManagement.code | |
Pattern Value | { |
250. PlanDefinition.action:ventilatorManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
252. PlanDefinition.action:ventilatorManagement.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
254. PlanDefinition.action:ventilatorManagement.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
256. PlanDefinition.action:ventilatorManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
258. PlanDefinition.action:bodyPositioning | |
Slice Name | bodyPositioning |
Control | 0..* |
260. PlanDefinition.action:bodyPositioning.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
262. PlanDefinition.action:bodyPositioning.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
264. PlanDefinition.action:bodyPositioning.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
266. PlanDefinition.action:bodyPositioning.code | |
Pattern Value | { |
268. PlanDefinition.action:bodyPositioning.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
270. PlanDefinition.action:bodyPositioning.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
272. PlanDefinition.action:bodyPositioning.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
274. PlanDefinition.action:bodyPositioning.definition[x] | |
Type | canonical(Body Positioning Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
276. PlanDefinition.action:sedationManagement | |
Slice Name | sedationManagement |
Control | 0..* |
278. PlanDefinition.action:sedationManagement.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
280. PlanDefinition.action:sedationManagement.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
282. PlanDefinition.action:sedationManagement.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
284. PlanDefinition.action:sedationManagement.code | |
Pattern Value | { |
286. PlanDefinition.action:sedationManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
288. PlanDefinition.action:sedationManagement.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
290. PlanDefinition.action:sedationManagement.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
292. PlanDefinition.action:sedationManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
294. PlanDefinition.action:painManagement | |
Slice Name | painManagement |
Control | 0..* |
296. PlanDefinition.action:painManagement.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
298. PlanDefinition.action:painManagement.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
300. PlanDefinition.action:painManagement.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
302. PlanDefinition.action:painManagement.code | |
Pattern Value | { |
304. PlanDefinition.action:painManagement.goalId | |
Control | 1..? |
Must Support | true |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
306. PlanDefinition.action:painManagement.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
308. PlanDefinition.action:painManagement.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
310. PlanDefinition.action:painManagement.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
312. PlanDefinition.action:assessment | |
Slice Name | assessment |
Control | 0..* |
314. PlanDefinition.action:assessment.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
316. PlanDefinition.action:assessment.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
318. PlanDefinition.action:assessment.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
320. PlanDefinition.action:assessment.code | |
Pattern Value | { |
322. PlanDefinition.action:assessment.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
324. PlanDefinition.action:assessment.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
326. PlanDefinition.action:assessment.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
328. PlanDefinition.action:assessment.definition[x] | |
Type | canonical(Assessment Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
330. PlanDefinition.action:procedure | |
Slice Name | procedure |
Control | 0..* |
332. PlanDefinition.action:procedure.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
334. PlanDefinition.action:procedure.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
336. PlanDefinition.action:procedure.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
338. PlanDefinition.action:procedure.code | |
Pattern Value | { |
340. PlanDefinition.action:procedure.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
342. PlanDefinition.action:procedure.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
344. PlanDefinition.action:procedure.definition[x] | |
Type | canonical(Procedure Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
346. PlanDefinition.action:other | |
Slice Name | other |
Control | 0..* |
348. PlanDefinition.action:other.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
350. PlanDefinition.action:other.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
352. PlanDefinition.action:other.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
354. PlanDefinition.action:other.code | |
Pattern Value | { |
356. PlanDefinition.action:other.goalId | |
Invariants | goal-must-be-linked: The goal linked by goalId is not defined ($this in %resource.goal.id ) |
358. PlanDefinition.action:other.timing[x]:timingTiming | |
Slice Name | timingTiming |
Type | Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
360. PlanDefinition.action:other.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
362. PlanDefinition.action:other.definition[x] | |
Type | canonical(Recommendation Action) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. PlanDefinition | |
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. |
Short | The definition of a plan for a series of actions, independent of any specific patient or context |
Control | 10..1* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) pld-3: goalid should reference the id of a goal definition (%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()) pld-4: targetId should reference the id of an action (%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()) selection-behavior-unique-or-no-value: If selectionBehavior is present, it must be the same for all actions in the group ( action.selectionBehavior.distinct().count() <= 1 )nested-action-requires-combination-method: If a nested action is present, a combination method must be present. ( action.exists() implies extension('https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method').exists() ) |
2. PlanDefinition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about the resource |
Control | 10..1 |
Type | Meta |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. PlanDefinition.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Short | Identifies where the resource comes from |
Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Control | 0..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
6. PlanDefinition.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Short | Profiles this resource claims to conform to |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Control | 10..* |
Type | canonical(StructureDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. PlanDefinition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. PlanDefinition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
12. PlanDefinition.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 40..* |
Type | Extension |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on PlanDefinition.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. PlanDefinition.extension:knowledgeCapability | |
Slice Name | knowledgeCapability |
Definition | Defines a knowledge capability afforded by this knowledge artifact. |
Short | shareable | computable | publishable | executable |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(knowledgeCapability) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. PlanDefinition.extension:knowledgeCapability.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on PlanDefinition.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. PlanDefinition.extension:knowledgeCapability.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability |
20. PlanDefinition.extension:knowledgeCapability.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ext-1 |
Binding | The codes SHALL be taken from For codes, see CPG Knowledge Capability (required to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-capability )A knowledge capability provided by a knowledge artifact |
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Pattern Value | computable |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. PlanDefinition.extension:knowledgeRepresentationLevel | |
Slice Name | knowledgeRepresentationLevel |
Definition | Defines a knowledge representation level provided by this knowledge artifact. |
Short | narrative | semi-structured | structured | executable |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(knowledgeRepresentationLevel) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. PlanDefinition.extension:knowledgeRepresentationLevel.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on PlanDefinition.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
26. PlanDefinition.extension:knowledgeRepresentationLevel.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel |
28. PlanDefinition.extension:knowledgeRepresentationLevel.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ext-1 |
Binding | The codes SHALL be taken from For codes, see CPG Knowledge Representation Level (required to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-representation-level )A level of knowledge representation provided by this artifact |
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Pattern Value | structured |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. PlanDefinition.extension:artifactComment | |
Slice Name | artifactComment |
Definition | A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user. |
Short | Additional documentation, review, or usage guidance |
Control | 0..* |
Type | Extension(CQFM Artifact Comment) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
32. PlanDefinition.extension:enabled | |
Slice Name | enabled |
Definition | Determines whether the artifact on which it appears is Enabled, as opposed to just Known. |
Short | Enabled? |
Comments | Systems that are capable of storing and retrieving knowledge artifacts SHALL use this element to distinguish between a Known and an actively Enabled artifact. Behavior described by the artifact should only be implemented if this element is present and has a value of true. |
Control | 0..1 |
Type | Extension(enabled) (Extension Type: boolean) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. PlanDefinition.extension:partOf | |
Slice Name | partOf |
Definition | Specifies the canonical URL of a Pathway or Strategy that this definition is part of. |
Short | Part of pathway |
Comments | For enrollment checking, if the computable PlanDefinition is not a Pathway or Strategy, then this extension is followed to attempt to determine a Pathway or Strategy to use for the enrollment check, recursively. |
Control | 1..1 |
Type | Extension(partOf) (Extension Type: canonical(PlanDefinition)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
36. PlanDefinition.extension:partOf.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on PlanDefinition.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
38. PlanDefinition.extension:partOf.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf |
40. PlanDefinition.extension:partOf.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ext-1 |
Type | canonical(Recommendation), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. PlanDefinition.extension:combinationMethod | |
Slice Name | combinationMethod |
Definition | Extension used on PlanDefinition.action to specify a method for combining the actions. |
Short | combinationMethod |
Control | 1..1 |
Type | Extension(Action Combination Method) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
44. PlanDefinition.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
46. PlanDefinition.url | |
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. |
Short | Canonical identifier for this plan definition, represented as a URI (globally unique) |
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Allows the plan definition to be referenced by a single globally unique identifier. |
Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$')) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. PlanDefinition.version | |
Definition | The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
Short | Business version of the plan definition |
Comments | There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. PlanDefinition.versionAlgorithm[x] | |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short | How to compare versions |
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm ) |
Type | Choice of: string, Coding |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. PlanDefinition.name | |
Definition | A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
Short | Name for this plan definition (computer friendly) |
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
Control | 10..1 This element is affected by the following invariants: cnl-0 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Support human navigation and code generation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. PlanDefinition.title | |
Definition | A short, descriptive, user-friendly title for the plan definition. |
Short | Name for this plan definition (human friendly) |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. PlanDefinition.type | |
Definition | A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. |
Short | order-set | clinical-protocol | eca-rule | workflow-definition |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type (extensible to http://hl7.org/fhir/ValueSet/plan-definition-type )The type of PlanDefinition. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. PlanDefinition.status | |
Definition | The status of this plan definition. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. PlanDefinition.experimental | |
Definition | A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
Short | For testing purposes, not real usage |
Comments | Allows filtering of plan definitions that are appropriate for use versus not. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. |
Meaning if Missing | If absent, this resource is treated as though it is not experimental. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. PlanDefinition.subject[x] | |
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. |
Short | Type of individual the plan definition is focused on |
Comments | Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. |
Control | 10..1 |
Type | canonical(Recommendation Eligibility Criteria, EvidenceVariable), Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Meaning if Missing | Patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. PlanDefinition.date | |
Definition | The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. |
Short | Date last changed |
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. |
Control | 10..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Alternate Names | Revision Date |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. PlanDefinition.publisher | |
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. |
Short | Name of the publisher/steward (organization or individual) |
Comments | Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. PlanDefinition.description | |
Definition | A free text natural language description of the plan definition from a consumer's perspective. |
Short | Natural language description of the plan definition |
Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created). |
Control | 10..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. PlanDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the plan definition. |
Short | Logic used by the plan definition |
Control | 0..1* |
Type | canonical(Library) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. PlanDefinition.goal | |
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. |
Short | What the plan is trying to accomplish |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on PlanDefinition.goal . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
74. PlanDefinition.goal.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
Must Support | true |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
76. PlanDefinition.goal.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
78. PlanDefinition.goal.category | |
Definition | Indicates a category the goal falls within. |
Short | E.g. Treatment, dietary, behavioral |
Control | 10..1 |
Binding | For example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/ValueSet/goal-category )Example codes for grouping goals for filtering or presentation. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
80. PlanDefinition.goal.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 10..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. PlanDefinition.goal.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. PlanDefinition.goal.category.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 10..1 This element is affected by the following invariants: cod-1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. PlanDefinition.goal.description | |
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". |
Short | Code or text describing the goal |
Comments | If no code is available, use CodeableConcept.text. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. PlanDefinition.goal:ventilatorManagement | |
Slice Name | ventilatorManagement |
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. |
Short | What the plan is trying to accomplish |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. PlanDefinition.goal:ventilatorManagement.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
92. PlanDefinition.goal:ventilatorManagement.category | |
Definition | Indicates a category the goal falls within. |
Short | E.g. Treatment, dietary, behavioral |
Control | 0..1 |
Binding | For example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/ValueSet/goal-category )Example codes for grouping goals for filtering or presentation. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. PlanDefinition.goal:ventilatorManagement.description | |
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". |
Short | Code or text describing the goal |
Comments | If no code is available, use CodeableConcept.text. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. PlanDefinition.goal:ventilatorManagement.target | |
Definition | Indicates what should be done and within what timeframe. |
Short | Target outcome for the goal |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. PlanDefinition.goal:ventilatorManagement.target.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
100. PlanDefinition.goal:ventilatorManagement.target.measure | |
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
Short | The parameter whose value is to be tracked |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see VS MII ICU Code Observation Beatmung [LOINC]http://hl7.org/fhir/ValueSet/observation-codes (extensible to https://www.medizininformatik-initiative.de/fhir/ext/modul-icu/ValueSet/Code-Observation-Beatmung-LOINC ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. PlanDefinition.goal:ventilatorManagement.target.detail[x] | |
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
Short | The target value to be achieved |
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value. |
Control | 10..1 |
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
104. PlanDefinition.goal:laboratoryValue | |
Slice Name | laboratoryValue |
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. |
Short | What the plan is trying to accomplish |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
106. PlanDefinition.goal:laboratoryValue.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
108. PlanDefinition.goal:laboratoryValue.category | |
Definition | Indicates a category the goal falls within. |
Short | E.g. Treatment, dietary, behavioral |
Control | 0..1 |
Binding | For example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/ValueSet/goal-category )Example codes for grouping goals for filtering or presentation. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
110. PlanDefinition.goal:laboratoryValue.description | |
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". |
Short | Code or text describing the goal |
Comments | If no code is available, use CodeableConcept.text. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
112. PlanDefinition.goal:laboratoryValue.target | |
Definition | Indicates what should be done and within what timeframe. |
Short | Target outcome for the goal |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
114. PlanDefinition.goal:laboratoryValue.target.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
116. PlanDefinition.goal:laboratoryValue.target.measure | |
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
Short | The parameter whose value is to be tracked |
Control | 10..1 |
Binding | For example codes, see LOINCCodeshttp://hl7.org/fhir/ValueSet/observation-codes (example to http://hl7.org/fhir/ValueSet/observation-codes )Identifies types of parameters that can be tracked to determine goal achievement. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
118. PlanDefinition.goal:laboratoryValue.target.measure.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 0..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
120. PlanDefinition.goal:laboratoryValue.target.measure.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
122. PlanDefinition.goal:laboratoryValue.target.measure.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 10..1 This element is affected by the following invariants: cod-1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
124. PlanDefinition.goal:laboratoryValue.target.detail[x] | |
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
Short | The target value to be achieved |
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value. |
Control | 10..1 |
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
126. PlanDefinition.goal:assessmentScale | |
Slice Name | assessmentScale |
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. |
Short | What the plan is trying to accomplish |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
128. PlanDefinition.goal:assessmentScale.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
130. PlanDefinition.goal:assessmentScale.category | |
Definition | Indicates a category the goal falls within. |
Short | E.g. Treatment, dietary, behavioral |
Control | 0..1 |
Binding | For example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/ValueSet/goal-category )Example codes for grouping goals for filtering or presentation. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. PlanDefinition.goal:assessmentScale.description | |
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". |
Short | Code or text describing the goal |
Comments | If no code is available, use CodeableConcept.text. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
134. PlanDefinition.goal:assessmentScale.target | |
Definition | Indicates what should be done and within what timeframe. |
Short | Target outcome for the goal |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
136. PlanDefinition.goal:assessmentScale.target.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
138. PlanDefinition.goal:assessmentScale.target.measure | |
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
Short | The parameter whose value is to be tracked |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Assessment Scaleshttp://hl7.org/fhir/ValueSet/observation-codes (extensible to https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/ValueSet/vs-assessment-scales ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
140. PlanDefinition.goal:assessmentScale.target.detail[x] | |
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
Short | The target value to be achieved |
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value. |
Control | 10..1 |
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
142. PlanDefinition.goal:other | |
Slice Name | other |
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. |
Short | What the plan is trying to accomplish |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
144. PlanDefinition.goal:other.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
146. PlanDefinition.goal:other.category | |
Definition | Indicates a category the goal falls within. |
Short | E.g. Treatment, dietary, behavioral |
Control | 0..1 |
Binding | For example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/ValueSet/goal-category )Example codes for grouping goals for filtering or presentation. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
148. PlanDefinition.goal:other.description | |
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". |
Short | Code or text describing the goal |
Comments | If no code is available, use CodeableConcept.text. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
150. PlanDefinition.goal:other.target | |
Definition | Indicates what should be done and within what timeframe. |
Short | Target outcome for the goal |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
152. PlanDefinition.goal:other.target.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
154. PlanDefinition.goal:other.target.measure | |
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
Short | The parameter whose value is to be tracked |
Control | 10..1 |
Binding | For example codes, see LOINCCodeshttp://hl7.org/fhir/ValueSet/observation-codes (example to http://hl7.org/fhir/ValueSet/observation-codes )Identifies types of parameters that can be tracked to determine goal achievement. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
156. PlanDefinition.goal:other.target.detail[x] | |
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. |
Short | The target value to be achieved |
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value. |
Control | 10..1 |
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
158. PlanDefinition.action | |
Definition | An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. |
Short | Action defined by the plan |
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information. |
Control | 10..* This element is affected by the following invariants: pld-3, pld-4 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on PlanDefinition.action . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
160. PlanDefinition.action.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
Definition | The strength of the recommendation assigned to this reference. The code system used specifies the rating scale used to rate this recommendation while the code specifies the actual recommendation rating (represented as a coded value) associated with this recommendation. |
Short | The strength of the recommendation |
Control | 0..1 |
Type | Extension(strengthOfRecommendation) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
162. PlanDefinition.action.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
Definition | Specifies whether the recommendation is "for" or "against" a particular activity. For example, the recommendation to prescribe a particular medication, versus the recommendation not to perform a particular procedure. |
Short | Recommendation for or against? |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(directionOfRecommendation) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
164. PlanDefinition.action.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
Definition | The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence. |
Short | The quality of the evidence |
Control | 0..1 |
Type | Extension(qualityOfEvidence) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
166. PlanDefinition.action.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
168. PlanDefinition.action.prefix | |
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A. |
Short | User-visible prefix for the action (e.g. 1. or A.) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
170. PlanDefinition.action.title | |
Definition | The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. |
Short | User-visible title |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
172. PlanDefinition.action.description | |
Definition | A brief description of the action used to provide a summary to display to the user. |
Short | Brief description of the action |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
174. PlanDefinition.action.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
176. PlanDefinition.action.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 10..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
178. PlanDefinition.action.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
180. PlanDefinition.action.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 10..1 This element is affected by the following invariants: cod-1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
182. PlanDefinition.action.reason | |
Definition | A description of why this action is necessary or appropriate. |
Short | Why the action should be performed |
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. |
Control | 0..* |
Binding | For example codes, see ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code (example to http://hl7.org/fhir/ValueSet/action-reason-code )Provides examples of reasons for actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
184. PlanDefinition.action.documentation | |
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. |
Short | Supporting documentation for the intended performer of the action |
Control | 0..* |
Type | RelatedArtifact |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
186. PlanDefinition.action.trigger | |
Definition | A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action. |
Short | When the action should be triggered |
Control | 0..* |
Type | TriggerDefinition |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
188. PlanDefinition.action.condition | |
Definition | An expression that describes applicability criteria or start/stop conditions for the action. |
Short | Whether or not the action is applicable |
Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
190. PlanDefinition.action.condition.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
192. PlanDefinition.action.condition.kind | |
Definition | The kind of condition. |
Short | applicability | start | stop |
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. |
Control | 1..1 |
Binding | The codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0 (required to http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0 )Defines the kinds of conditions that can appear on actions. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
194. PlanDefinition.action.timing[x] | |
Definition | An optional value describing when the action should be performed. |
Short | When the action should take place |
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. |
Control | 0..1 |
Type | Choice of: Age, Duration, Range, Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on PlanDefinition.action.timing[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
196. PlanDefinition.action.timing[x]:timingTiming | |
Slice Name | timingTiming |
Definition | An optional value describing when the action should be performed. |
Short | When the action should take place |
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. |
Control | 0..1 |
Type | Timing, Duration, Range, Age |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
198. PlanDefinition.action.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
200. PlanDefinition.action.timing[x]:timingTiming.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
202. PlanDefinition.action.participant | |
Definition | Indicates who should participate in performing the action described. |
Short | Who should participate in the action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
204. PlanDefinition.action.participant.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
206. PlanDefinition.action.participant.role | |
Definition | The role the participant should play in performing the described action. |
Short | E.g. Nurse, Surgeon, Parent |
Control | 0..1 |
Binding | The codes SHOULD be taken from For example codes, see CPG Common Personahttp://terminology.hl7.org/ValueSet/action-participant-role (preferred to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-common-persona )Personas used in identifying participants and their roles in computable content Defines roles played by participants for the action. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
208. PlanDefinition.action.type | |
Definition | The type of action to perform (create, update, remove). |
Short | create | update | remove | fire-event |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ActionTypehttp://hl7.org/fhir/ValueSet/action-type (extensible to http://hl7.org/fhir/ValueSet/action-type )The type of action to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
210. PlanDefinition.action.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
212. PlanDefinition.action.dynamicValue | |
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. |
Short | Dynamic aspects of the definition |
Comments | Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
214. PlanDefinition.action.dynamicValue.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
216. PlanDefinition.action.dynamicValue.path | |
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). |
Short | The path to the element to be set dynamically |
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
218. PlanDefinition.action.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Short | An expression that provides the dynamic value for the customization |
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. |
Control | 0..1 |
Type | Expression |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
220. PlanDefinition.action.action | |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
222. PlanDefinition.action:combination | |
Slice Name | combination |
Definition | An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. |
Short | Action defined by the plan |
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information. |
Control | 0..* This element is affected by the following invariants: pld-3, pld-4 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) nested-action-requires-combination-method: If a nested action is present, a combination method must be present. ( action.exists() implies extension('https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method').exists() ) |
224. PlanDefinition.action:combination.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on PlanDefinition.action.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
226. PlanDefinition.action:combination.extension:strengthOfRecommendation | |
Slice Name | strengthOfRecommendation |
Definition | The strength of the recommendation assigned to this reference. The code system used specifies the rating scale used to rate this recommendation while the code specifies the actual recommendation rating (represented as a coded value) associated with this recommendation. |
Short | The strength of the recommendation |
Control | 0..1 |
Type | Extension(strengthOfRecommendation) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
228. PlanDefinition.action:combination.extension:directionOfRecommendation | |
Slice Name | directionOfRecommendation |
Definition | Specifies whether the recommendation is "for" or "against" a particular activity. For example, the recommendation to prescribe a particular medication, versus the recommendation not to perform a particular procedure. |
Short | Recommendation for or against? |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(directionOfRecommendation) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
230. PlanDefinition.action:combination.extension:qualityOfEvidence | |
Slice Name | qualityOfEvidence |
Definition | The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence. |
Short | The quality of the evidence |
Control | 0..1 |
Type | Extension(qualityOfEvidence) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
232. PlanDefinition.action:combination.extension:combinationMethod | |
Slice Name | combinationMethod |
Definition | Extension used on PlanDefinition.action to specify a method for combining the actions. |
Short | combinationMethod |
Control | 1..1 |
Type | Extension(Action Combination Method) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
234. PlanDefinition.action:combination.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
236. PlanDefinition.action:combination.prefix | |
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A. |
Short | User-visible prefix for the action (e.g. 1. or A.) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
238. PlanDefinition.action:combination.title | |
Definition | The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. |
Short | User-visible title |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
240. PlanDefinition.action:combination.description | |
Definition | A brief description of the action used to provide a summary to display to the user. |
Short | Brief description of the action |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
242. PlanDefinition.action:combination.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 0..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
244. PlanDefinition.action:combination.reason | |
Definition | A description of why this action is necessary or appropriate. |
Short | Why the action should be performed |
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. |
Control | 0..* |
Binding | For example codes, see ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code (example to http://hl7.org/fhir/ValueSet/action-reason-code )Provides examples of reasons for actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
246. PlanDefinition.action:combination.documentation | |
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. |
Short | Supporting documentation for the intended performer of the action |
Control | 0..* |
Type | RelatedArtifact |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
248. PlanDefinition.action:combination.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 0..0* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
250. PlanDefinition.action:combination.trigger | |
Definition | A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action. |
Short | When the action should be triggered |
Control | 0..* |
Type | TriggerDefinition |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
252. PlanDefinition.action:combination.condition | |
Definition | An expression that describes applicability criteria or start/stop conditions for the action. |
Short | Whether or not the action is applicable |
Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
254. PlanDefinition.action:combination.condition.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
256. PlanDefinition.action:combination.condition.kind | |
Definition | The kind of condition. |
Short | applicability | start | stop |
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. |
Control | 1..1 |
Binding | The codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0 (required to http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0 )Defines the kinds of conditions that can appear on actions. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
258. PlanDefinition.action:combination.timing[x]:timingTiming | |
Slice Name | timingTiming |
Definition | An optional value describing when the action should be performed. |
Short | When the action should take place |
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. |
Control | 0..1 |
Type | Timing, Duration, Range, Age |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
260. PlanDefinition.action:combination.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
262. PlanDefinition.action:combination.timing[x]:timingTiming.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
264. PlanDefinition.action:combination.participant | |
Definition | Indicates who should participate in performing the action described. |
Short | Who should participate in the action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
266. PlanDefinition.action:combination.participant.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
268. PlanDefinition.action:combination.participant.role | |
Definition | The role the participant should play in performing the described action. |
Short | E.g. Nurse, Surgeon, Parent |
Control | 0..1 |
Binding | The codes SHOULD be taken from For example codes, see CPG Common Personahttp://terminology.hl7.org/ValueSet/action-participant-role (preferred to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-common-persona )Personas used in identifying participants and their roles in computable content Defines roles played by participants for the action. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
270. PlanDefinition.action:combination.type | |
Definition | The type of action to perform (create, update, remove). |
Short | create | update | remove | fire-event |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ActionTypehttp://hl7.org/fhir/ValueSet/action-type (extensible to http://hl7.org/fhir/ValueSet/action-type )The type of action to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
272. PlanDefinition.action:combination.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..01 |
Type | canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
274. PlanDefinition.action:combination.dynamicValue | |
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. |
Short | Dynamic aspects of the definition |
Comments | Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
276. PlanDefinition.action:combination.dynamicValue.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
278. PlanDefinition.action:combination.dynamicValue.path | |
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). |
Short | The path to the element to be set dynamically |
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
280. PlanDefinition.action:combination.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Short | An expression that provides the dynamic value for the customization |
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. |
Control | 0..1 |
Type | Expression |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
282. PlanDefinition.action:combination.action | |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on PlanDefinition.action.action . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
284. PlanDefinition.action:combination.action.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
286. PlanDefinition.action:combination.action.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
288. PlanDefinition.action:combination.action.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 10..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
290. PlanDefinition.action:combination.action.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
292. PlanDefinition.action:combination.action.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 10..1 This element is affected by the following invariants: cod-1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
294. PlanDefinition.action:combination.action.timing[x] | |
Definition | An optional value describing when the action should be performed. |
Short | When the action should take place |
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. |
Control | 0..1 |
Type | Choice of: Age, Duration, Range, Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on PlanDefinition.action.action.timing[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
296. PlanDefinition.action:combination.action.timing[x]:timingTiming | |
Slice Name | timingTiming |
Definition | An optional value describing when the action should be performed. |
Short | When the action should take place |
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. |
Control | 0..1 |
Type | Timing, Duration, Range, Age |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
298. PlanDefinition.action:combination.action.timing[x]:timingTiming.extension:timingRelativeTime | |
Slice Name | timingRelativeTime |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(RelativeTime) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
300. PlanDefinition.action:combination.action.timing[x]:timingTiming.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
302. PlanDefinition.action:combination.action:combination | |
Slice Name | combination |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
304. PlanDefinition.action:combination.action:combination.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
306. PlanDefinition.action:combination.action:combination.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
308. PlanDefinition.action:combination.action:combination.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 0..0* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
310. PlanDefinition.action:combination.action:combination.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..01 |
Type | Choice of: canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
312. PlanDefinition.action:combination.action:combination.action | |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 10..* |
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
314. PlanDefinition.action:combination.action:drugAdministration | |
Slice Name | drugAdministration |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
316. PlanDefinition.action:combination.action:drugAdministration.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
318. PlanDefinition.action:combination.action:drugAdministration.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
320. PlanDefinition.action:combination.action:drugAdministration.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
322. PlanDefinition.action:combination.action:drugAdministration.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(Drug Administration Action, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
324. PlanDefinition.action:combination.action:ventilatorManagement | |
Slice Name | ventilatorManagement |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
326. PlanDefinition.action:combination.action:ventilatorManagement.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
328. PlanDefinition.action:combination.action:ventilatorManagement.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
330. PlanDefinition.action:combination.action:ventilatorManagement.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 10..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
332. PlanDefinition.action:combination.action:ventilatorManagement.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(Recommendation Action, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
334. PlanDefinition.action:combination.action:bodyPositioning | |
Slice Name | bodyPositioning |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
336. PlanDefinition.action:combination.action:bodyPositioning.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
338. PlanDefinition.action:combination.action:bodyPositioning.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
340. PlanDefinition.action:combination.action:bodyPositioning.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
342. PlanDefinition.action:combination.action:bodyPositioning.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(Body Positioning Action, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
344. PlanDefinition.action:combination.action:sedationManagement | |
Slice Name | sedationManagement |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
346. PlanDefinition.action:combination.action:sedationManagement.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
348. PlanDefinition.action:combination.action:sedationManagement.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
350. PlanDefinition.action:combination.action:sedationManagement.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 10..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
352. PlanDefinition.action:combination.action:sedationManagement.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(Recommendation Action, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
354. PlanDefinition.action:combination.action:painManagement | |
Slice Name | painManagement |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
356. PlanDefinition.action:combination.action:painManagement.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
358. PlanDefinition.action:combination.action:painManagement.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
360. PlanDefinition.action:combination.action:painManagement.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 10..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
362. PlanDefinition.action:combination.action:painManagement.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical(Recommendation Action, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
364. PlanDefinition.action:combination.action:assessment | |
Slice Name | assessment |
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. |
Short | A sub-action |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
366. PlanDefinition.action:combination.action:assessment.modifierExtension | |
Definition | 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
368. PlanDefinition.action:combination.action:assessment.code | |
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. |
Short | Code representing the meaning of the action or sub-actions |
Control | 10..1 |
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )Provides examples of actions to be performed. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
370. PlanDefinition.action:combination.action:assessment.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. |
Short | What goals this action supports |
Control | 0..* This element is affected by the following invariants: pld-3 |
Type | id |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) goal-must-be-linked: The goal linked by goalId is not defined ( $this in %resource.goal.id ) |
372. PlanDefinition.action:combination.action:assessment.definition[x] | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. |
Short | Description of the activity to be performed |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. |
Control | 0..1 |
Type | canonical( |