Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot United States of America flag

Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-resp-net-ig/ and changes regularly. See the Directory of published versions

Resource Profile: RESPNETPlanDefinition - Detailed Descriptions

Active as of 2023-12-21

Definitions for the resp-net-plandefinition resource profile.

Guidance on how to interpret the contents of this table can be found here

0. PlanDefinition
Definition

This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to RESP-NET.

ShortRESP-NET Knowledge Artifact
Must Supporttrue
2. PlanDefinition.action
Control6..?
Must Supporttrue
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are ordered and Open, and can be differentiated using the following discriminators:
  • value @ id
4. PlanDefinition.action.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

Must Supporttrue
6. PlanDefinition.action.input
8. PlanDefinition.action:startWorkflow
Slice NamestartWorkflow
Definition

Defines the "startr" action

ShortStart Workflow Action
Control1..1
Must Supporttrue
10. PlanDefinition.action:startWorkflow.id
Control1..?
Must Supporttrue
Fixed Valuestart-workflow
12. PlanDefinition.action:startWorkflow.description
Definition

Description of the start workflow action.

ShortStarts the workflow
Control1..?
Must Supporttrue
Fixed ValueThis action represents the start of the reporting workflow in response to the encounter-end event
14. PlanDefinition.action:startWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.

ShortText equivalent of the start workflow action.
Control1..?
Must Supporttrue
Fixed ValueStart the reporting workflow in response to an encounter-end event
16. PlanDefinition.action:startWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..1
Must Supporttrue
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
18. PlanDefinition.action:startWorkflow.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..?
Must Supporttrue
20. PlanDefinition.action:startWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
24. PlanDefinition.action:startWorkflow.trigger.type
Fixed Valuenamed-event
26. PlanDefinition.action:startWorkflow.trigger.name
Definition

The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

Fixed Valueencounter-end
28. PlanDefinition.action:startWorkflow.relatedAction
Control1..1
Must Supporttrue
30. PlanDefinition.action:startWorkflow.relatedAction.actionId
Fixed Valuecheck-reportability
32. PlanDefinition.action:startWorkflow.relatedAction.relationship
Fixed Valuebefore-start
34. PlanDefinition.action:startWorkflow.relatedAction.offsetDuration
Control0..1
TypeDuration
Example<br/><b>Wait 72 hour before next action.</b>:&lt;valueDuration&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;value&nbsp;value=&quot;72&quot;/&gt;<br/>&nbsp;&nbsp;&lt;unit&nbsp;value=&quot;h&quot;/&gt;<br/>&lt;/valueDuration&gt;<br/>
36. PlanDefinition.action:positiveLabResultWorkflow
Slice NamepositiveLabResultWorkflow
Definition

Defines the "startr" action

ShortStart Workflow Action due to a positive lab result
Control1..1
Must Supporttrue
38. PlanDefinition.action:positiveLabResultWorkflow.id
Control1..?
Must Supporttrue
Fixed Valuestart-workflow-for-positive-lab-result
40. PlanDefinition.action:positiveLabResultWorkflow.description
Definition

Description of the start workflow action.

ShortStarts the workflow due to a positive lab result
Control1..?
Must Supporttrue
Fixed ValueThis action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event
42. PlanDefinition.action:positiveLabResultWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.

ShortText equivalent of the start workflow action for positive lab result.
Control1..?
Must Supporttrue
Fixed ValueStart the reporting workflow in response to an labresult-change event
44. PlanDefinition.action:positiveLabResultWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..1
Must Supporttrue
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
46. PlanDefinition.action:positiveLabResultWorkflow.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..?
Must Supporttrue
48. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
52. PlanDefinition.action:positiveLabResultWorkflow.trigger.type
Fixed Valuenamed-event
54. PlanDefinition.action:positiveLabResultWorkflow.trigger.name
Definition

The name of the event, labresult-change in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable $labresult

Fixed Valuelabresult-change
56. PlanDefinition.action:positiveLabResultWorkflow.relatedAction
Control1..1
Must Supporttrue
58. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.actionId
Fixed Valuecheck-reportability
60. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.relationship
Fixed Valuebefore-start
62. PlanDefinition.action:executeReportingWorkflow
Slice NameexecuteReportingWorkflow
Definition

Defines the "Execute Reporting Workflow" action

ShortExecute Reporting Workflow
Control1..1
Must Supporttrue
64. PlanDefinition.action:executeReportingWorkflow.id
Control1..?
Must Supporttrue
Fixed Valuecheck-reportability
66. PlanDefinition.action:executeReportingWorkflow.description
Definition

Check for Reportable Conditions.

ShortCheck for reportability conditions
Control1..?
Must Supporttrue
Fixed ValueThis action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions.
68. PlanDefinition.action:executeReportingWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "execute-reporting-workflow" action.

ShortCode for the "execute-reporting-workflow" action.
Control1..1
Must Supporttrue
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;execute-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
70. PlanDefinition.action:executeReportingWorkflow.action
Control2..?
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
72. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice NameisAmbulatoryEncounterReportable
Control1..1
TypeBackboneElement
Must Supporttrue
74. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.id
Control1..?
Must Supporttrue
Fixed Valueis-ambulatory-encounter-reportable
76. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Control1..1
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
78. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition
80. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind
Fixed Valueapplicability
82. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression
Control1..?
Must Supporttrue
84. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Fixed Valuetext/fhirpath
86. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
88. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
90. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction
92. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.actionId
Fixed Valuecreate-resp-net-report
94. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship
Fixed Valuebefore-start
96. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice NameisInpatientEncounterReportable
Control1..1
TypeBackboneElement
Must Supporttrue
98. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.id
Control1..?
Must Supporttrue
Fixed Valueis-inpatient-encounter-reportable
100. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Control1..1
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
102. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition
104. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind
Fixed Valueapplicability
106. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression
Control1..?
Must Supporttrue
108. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Fixed Valuetext/fhirpath
110. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
112. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
114. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction
116. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.actionId
Fixed Valuecreate-resp-net-report
118. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship
Fixed Valuebefore-start
120. PlanDefinition.action:createReport
Slice NamecreateReport
Control1..1
122. PlanDefinition.action:createReport.id
Control1..?
Must Supporttrue
Fixed Valuecreate-resp-net-report
124. PlanDefinition.action:createReport.description
Fixed ValueThis action represents the creation, validation and submission of the RESP-NET report.
126. PlanDefinition.action:createReport.code
Control1..?
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;create-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
128. PlanDefinition.action:createReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
130. PlanDefinition.action:createReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
132. PlanDefinition.action:createReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement

Must Supporttrue
134. PlanDefinition.action:createReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
136. PlanDefinition.action:createReport.relatedAction
138. PlanDefinition.action:createReport.relatedAction.actionId
Fixed Valuevalidate-resp-net-report
140. PlanDefinition.action:createReport.relatedAction.relationship
Fixed Valuebefore-start
142. PlanDefinition.action:validateReport
Slice NamevalidateReport
Control1..1
144. PlanDefinition.action:validateReport.id
Control1..?
Must Supporttrue
Fixed Valuevalidate-resp-net-report
146. PlanDefinition.action:validateReport.description
Fixed ValueThis action represents the validation of the RESP-NET Report
148. PlanDefinition.action:validateReport.code
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;validate-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
150. PlanDefinition.action:validateReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
152. PlanDefinition.action:validateReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
154. PlanDefinition.action:validateReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement

Must Supporttrue
156. PlanDefinition.action:validateReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue
158. PlanDefinition.action:validateReport.relatedAction
160. PlanDefinition.action:validateReport.relatedAction.actionId
Fixed Valuesubmit-resp-net-report
162. PlanDefinition.action:validateReport.relatedAction.relationship
Fixed Valuebefore-start
164. PlanDefinition.action:submitRespNetReport
Slice NamesubmitRespNetReport
Definition

Defines the routing and sending of the RESP-NET Report

ShortRoute and send RESP-NET Report
Control1..1
166. PlanDefinition.action:submitRespNetReport.id
Control1..?
Must Supporttrue
Fixed Valuesubmit-resp-net-report
168. PlanDefinition.action:submitRespNetReport.description
Definition

Description of the route and send action.

ShortDescription of the route and send action.
Control1..?
Must Supporttrue
Fixed ValueThis action represents the routing and sending of the RESP-NET Report
170. PlanDefinition.action:submitRespNetReport.textEquivalent
Control1..?
Must Supporttrue
Fixed ValueRoute and send RESP-NET Report
172. PlanDefinition.action:submitRespNetReport.code
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;submit-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
174. PlanDefinition.action:submitRespNetReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
176. PlanDefinition.action:submitRespNetReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..1
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here

0. PlanDefinition
Definition

This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to RESP-NET.


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 artifacts such as clinical decision support rules, order sets and protocols.

ShortRESP-NET Knowledge ArtifactThe definition of a plan for a series of actions, independent of any specific patient or context
Control10..1*
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. 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.

ShortA 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 it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PlanDefinition.extension:receiverEndpoint
Slice NamereceiverEndpoint
Definition

Indicates the address where the report has to be sent.

ShortIndicates the address where the report has to be sent.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Receiver Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. PlanDefinition.extension:asyncIndicator
Slice NameasyncIndicator
Definition

A value of true indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously.

ShortUS Public Health Async Indicator Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. PlanDefinition.extension:contentEncrypted
Slice NamecontentEncrypted
Definition

Indicates whether the data in the content bundle is encrypted or not.

ShortUS Public Health Data Encrypted Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. PlanDefinition.extension:jwksForContentEncryption
Slice NamejwksForContentEncryption
Definition

Indicates the location of the public key to be used for encryption when submitting data to the Data Receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PlanDefinition.extension:contentEncryptionAlgorithm
Slice NamecontentEncryptionAlgorithm
Definition

Indicates the algorithms that would be acceptable for encryption of the data prior to submitting to the Data Receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Data Encryption Algorithm) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. PlanDefinition.extension:expectedResponseDuration
Slice NameexpectedResponseDuration
Definition

Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination.

ShortUS Public Health Expected Response Time Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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())
18. 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 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.

ShortCanonical 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.


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.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the plan definition to be referenced by a single globally unique identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. PlanDefinition.identifier
Definition

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the plan definition
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. 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.

ShortBusiness 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].

NoteThis is a business versionId, not a resource version id (see discussion)
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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.

ShortName 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.

Control10..1
This element is affected by the following invariants: inv-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. PlanDefinition.title
Definition

A short, descriptive, user-friendly title for the plan definition.

ShortName for this plan definition (human friendly)
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PlanDefinition.type
Definition

Type of this PlanDefinition


A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

ShortType of this PlanDefinitionorder-set | clinical-protocol | eca-rule | workflow-definition
Control10..1
BindingUnless not suitable, these codes SHALL be taken from PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type

The type of PlanDefinition.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://terminology.hl7.org/CodeSystem/plan-definition-type&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;workflow-definition&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;display&nbsp;value=&quot;Workflow&nbsp;Definition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PlanDefinition.status
Definition

The status of this plan definition. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. 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.

ShortFor testing purposes, not real usage
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

Control10..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. PlanDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the plan definition.

ShortType of individual the plan definition is focused on
Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. PlanDefinition.date
Definition

Date the PlanDefinition was last changed


The date (and optionally time) when the plan definition was published. 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.

ShortDate the PlanDefinition was last changedDate last changed
Comments

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.

Control10..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.publisher
Definition

Name of the agency that published this PlanDefinition


The name of the organization or individual that published the plan definition.

ShortName of the agency that published this PlanDefinitionName of the publisher (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.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

Alternate Namessteward
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a telephone number, etc.

Control0..*
TypeContactDetail
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.description
Definition

A free text natural language description of the plan definition from a consumer's perspective.

ShortNatural language description of the plan definition
Comments

This description can be used to capture details such as why the plan definition was built, 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).

Control10..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namesscope
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

ShortThe context that the content is intended to support
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PlanDefinition.jurisdiction
Definition

A legal or geographic region in which the plan definition is intended to be used.

ShortIntended jurisdiction for plan definition (if applicable)
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction

Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.effectivePeriod
Definition

The period during which the PlanDefinition is valid


The period during which the plan definition content was or is planned to be in active use.

ShortWhen the PlanDefinition is validWhen the plan definition is expected to be used
Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.effectivePeriod.start
Definition

The start of the time period when this PlanDefinition goes into effect


The start of the period. The boundary is inclusive.

ShortThe start of the time period when this PlanDefinition goes into effectStarting time with inclusive boundary
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Control10..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PlanDefinition.library
Definition

A reference to a Library resource containing any formal logic used by the plan definition.

ShortLogic used by the plan definition
Control0..*
Typecanonical(Library)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.action
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.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.

Control60..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are ordered and Open, and can be differentiated using the following discriminators:
  • value @ id
56. PlanDefinition.action.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
60. PlanDefinition.action.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.action.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
68. PlanDefinition.action.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.action.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
74. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PlanDefinition.action.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.action.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
84. PlanDefinition.action.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
86. PlanDefinition.action.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PlanDefinition.action.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. PlanDefinition.action.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. PlanDefinition.action.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
98. PlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. PlanDefinition.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
104. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. 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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. PlanDefinition.action:startWorkflow
Slice NamestartWorkflow
Definition

Defines the "startr" action


An action or group of actions to be taken as part of the plan.

ShortStart Workflow ActionAction 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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. PlanDefinition.action:startWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuestart-workflow
114. PlanDefinition.action:startWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
116. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
118. PlanDefinition.action:startWorkflow.description
Definition

Description of the start workflow action.


A brief description of the action used to provide a summary to display to the user.

ShortStarts the workflowBrief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the reporting workflow in response to the encounter-end event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. PlanDefinition.action:startWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.


A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortText equivalent of the start workflow action.Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueStart the reporting workflow in response to an encounter-end event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. PlanDefinition.action:startWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "start" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. PlanDefinition.action:startWorkflow.trigger
Definition

When the "start" action should be triggered.


A description of when the action should be triggered.

ShortWhen the "start" action should be triggered.When the action should be triggered
Control10..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. PlanDefinition.action:startWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
128. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
130. PlanDefinition.action:startWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. PlanDefinition.action:startWorkflow.trigger.name
Definition

The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter


A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valueencounter-end
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. PlanDefinition.action:startWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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.action:startWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. PlanDefinition.action:startWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. PlanDefinition.action:startWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. PlanDefinition.action:startWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. PlanDefinition.action:startWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
148. PlanDefinition.action:startWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
150. PlanDefinition.action:startWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. PlanDefinition.action:startWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. PlanDefinition.action:startWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. PlanDefinition.action:startWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. PlanDefinition.action:startWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. PlanDefinition.action:startWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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:startWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuecheck-reportability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. PlanDefinition.action:startWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. PlanDefinition.action:startWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
168. PlanDefinition.action:startWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Example<br/><b>Wait 72 hour before next action.</b>:&lt;valueDuration&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;value&nbsp;value=&quot;72&quot;/&gt;<br/>&nbsp;&nbsp;&lt;unit&nbsp;value=&quot;h&quot;/&gt;<br/>&lt;/valueDuration&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. PlanDefinition.action:startWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. PlanDefinition.action:startWorkflow.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. PlanDefinition.action:positiveLabResultWorkflow
Slice NamepositiveLabResultWorkflow
Definition

Defines the "startr" action


An action or group of actions to be taken as part of the plan.

ShortStart Workflow Action due to a positive lab resultAction 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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. PlanDefinition.action:positiveLabResultWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuestart-workflow-for-positive-lab-result
178. PlanDefinition.action:positiveLabResultWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
180. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
182. PlanDefinition.action:positiveLabResultWorkflow.description
Definition

Description of the start workflow action.


A brief description of the action used to provide a summary to display to the user.

ShortStarts the workflow due to a positive lab resultBrief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. PlanDefinition.action:positiveLabResultWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.


A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortText equivalent of the start workflow action for positive lab result.Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueStart the reporting workflow in response to an labresult-change event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. PlanDefinition.action:positiveLabResultWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "start" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. PlanDefinition.action:positiveLabResultWorkflow.trigger
Definition

When the "start" action should be triggered.


A description of when the action should be triggered.

ShortWhen the "start" action should be triggered.When the action should be triggered
Control10..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
192. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
194. PlanDefinition.action:positiveLabResultWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. PlanDefinition.action:positiveLabResultWorkflow.trigger.name
Definition

The name of the event, labresult-change in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable $labresult


A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuelabresult-change
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. PlanDefinition.action:positiveLabResultWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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:positiveLabResultWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. PlanDefinition.action:positiveLabResultWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. PlanDefinition.action:positiveLabResultWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. PlanDefinition.action:positiveLabResultWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
212. PlanDefinition.action:positiveLabResultWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
214. PlanDefinition.action:positiveLabResultWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. PlanDefinition.action:positiveLabResultWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. PlanDefinition.action:positiveLabResultWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. PlanDefinition.action:positiveLabResultWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. PlanDefinition.action:positiveLabResultWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
226. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuecheck-reportability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
232. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. PlanDefinition.action:positiveLabResultWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. PlanDefinition.action:positiveLabResultWorkflow.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. PlanDefinition.action:executeReportingWorkflow
Slice NameexecuteReportingWorkflow
Definition

Defines the "Execute Reporting Workflow" action


An action or group of actions to be taken as part of the plan.

ShortExecute Reporting WorkflowAction 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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. PlanDefinition.action:executeReportingWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuecheck-reportability
242. PlanDefinition.action:executeReportingWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
244. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
246. PlanDefinition.action:executeReportingWorkflow.description
Definition

Check for Reportable Conditions.


A brief description of the action used to provide a summary to display to the user.

ShortCheck for reportability conditionsBrief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. PlanDefinition.action:executeReportingWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "execute-reporting-workflow" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "execute-reporting-workflow" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;execute-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. PlanDefinition.action:executeReportingWorkflow.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. PlanDefinition.action:executeReportingWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
254. PlanDefinition.action:executeReportingWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. PlanDefinition.action:executeReportingWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
260. PlanDefinition.action:executeReportingWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. PlanDefinition.action:executeReportingWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. PlanDefinition.action:executeReportingWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. PlanDefinition.action:executeReportingWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. PlanDefinition.action:executeReportingWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
270. PlanDefinition.action:executeReportingWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
272. PlanDefinition.action:executeReportingWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. PlanDefinition.action:executeReportingWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. PlanDefinition.action:executeReportingWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. PlanDefinition.action:executeReportingWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. PlanDefinition.action:executeReportingWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. PlanDefinition.action:executeReportingWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
284. PlanDefinition.action:executeReportingWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
286. PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
290. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. PlanDefinition.action:executeReportingWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. PlanDefinition.action:executeReportingWorkflow.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.

ShortA sub-action
Control20..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
296. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice NameisAmbulatoryEncounterReportable
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valueis-ambulatory-encounter-reportable
300. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..1*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
308. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
316. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
318. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
320. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
324. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuecreate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
326. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
328. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice NameisInpatientEncounterReportable
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
330. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valueis-inpatient-encounter-reportable
332. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
334. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..1*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
336. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
338. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
340. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
350. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
352. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
356. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuecreate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
358. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
360. PlanDefinition.action:createReport
Slice NamecreateReport
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
362. PlanDefinition.action:createReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuecreate-resp-net-report
364. PlanDefinition.action:createReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
366. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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:createReport.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the creation, validation and submission of the RESP-NET report.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. PlanDefinition.action:createReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;create-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. PlanDefinition.action:createReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
374. PlanDefinition.action:createReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
376. PlanDefinition.action:createReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
378. PlanDefinition.action:createReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
380. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
382. PlanDefinition.action:createReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. PlanDefinition.action:createReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. PlanDefinition.action:createReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. PlanDefinition.action:createReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
390. PlanDefinition.action:createReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
392. PlanDefinition.action:createReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
394. PlanDefinition.action:createReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
396. PlanDefinition.action:createReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
398. PlanDefinition.action:createReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement


Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
400. PlanDefinition.action:createReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
402. PlanDefinition.action:createReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
404. PlanDefinition.action:createReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
406. PlanDefinition.action:createReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
408. PlanDefinition.action:createReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
410. PlanDefinition.action:createReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuevalidate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
412. PlanDefinition.action:createReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
414. PlanDefinition.action:createReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
416. PlanDefinition.action:createReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
418. PlanDefinition.action:createReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. PlanDefinition.action:createReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
422. PlanDefinition.action:validateReport
Slice NamevalidateReport
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
424. PlanDefinition.action:validateReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuevalidate-resp-net-report
426. PlanDefinition.action:validateReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
428. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
430. PlanDefinition.action:validateReport.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the validation of the RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
432. PlanDefinition.action:validateReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;validate-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
434. PlanDefinition.action:validateReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
436. PlanDefinition.action:validateReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
438. PlanDefinition.action:validateReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
440. PlanDefinition.action:validateReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
442. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
444. PlanDefinition.action:validateReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
446. PlanDefinition.action:validateReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
448. PlanDefinition.action:validateReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
450. PlanDefinition.action:validateReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
452. PlanDefinition.action:validateReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
454. PlanDefinition.action:validateReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
456. PlanDefinition.action:validateReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
458. PlanDefinition.action:validateReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
460. PlanDefinition.action:validateReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement


Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
462. PlanDefinition.action:validateReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
464. PlanDefinition.action:validateReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
466. PlanDefinition.action:validateReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
468. PlanDefinition.action:validateReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
470. PlanDefinition.action:validateReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
472. PlanDefinition.action:validateReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuesubmit-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
474. PlanDefinition.action:validateReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
476. PlanDefinition.action:validateReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
478. PlanDefinition.action:validateReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
480. PlanDefinition.action:validateReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
482. PlanDefinition.action:validateReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
484. PlanDefinition.action:submitRespNetReport
Slice NamesubmitRespNetReport
Definition

Defines the routing and sending of the RESP-NET Report


An action or group of actions to be taken as part of the plan.

ShortRoute and send RESP-NET ReportAction 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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
486. PlanDefinition.action:submitRespNetReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuesubmit-resp-net-report
488. PlanDefinition.action:submitRespNetReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
490. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
492. PlanDefinition.action:submitRespNetReport.description
Definition

Description of the route and send action.


A brief description of the action used to provide a summary to display to the user.

ShortDescription of the route and send action.Brief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the routing and sending of the RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
494. PlanDefinition.action:submitRespNetReport.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueRoute and send RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
496. PlanDefinition.action:submitRespNetReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;submit-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
498. PlanDefinition.action:submitRespNetReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
500. PlanDefinition.action:submitRespNetReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
502. PlanDefinition.action:submitRespNetReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
504. PlanDefinition.action:submitRespNetReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
506. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
508. PlanDefinition.action:submitRespNetReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
510. PlanDefinition.action:submitRespNetReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
512. PlanDefinition.action:submitRespNetReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
514. PlanDefinition.action:submitRespNetReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
516. PlanDefinition.action:submitRespNetReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
518. PlanDefinition.action:submitRespNetReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
520. PlanDefinition.action:submitRespNetReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
522. PlanDefinition.action:submitRespNetReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
524. PlanDefinition.action:submitRespNetReport.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
526. PlanDefinition.action:submitRespNetReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
528. PlanDefinition.action:submitRespNetReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
530. PlanDefinition.action:submitRespNetReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
532. PlanDefinition.action:submitRespNetReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
534. PlanDefinition.action:submitRespNetReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
536. PlanDefinition.action:submitRespNetReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
538. PlanDefinition.action:submitRespNetReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
540. PlanDefinition.action:submitRespNetReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
542. PlanDefinition.action:submitRespNetReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
544. PlanDefinition.action:submitRespNetReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. PlanDefinition
Definition

This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to RESP-NET.

ShortRESP-NET Knowledge Artifact
Control1..1
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. PlanDefinition.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. 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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.

ShortA 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 it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PlanDefinition.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PlanDefinition.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. PlanDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. PlanDefinition.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. PlanDefinition.extension:receiverEndpoint
Slice NamereceiverEndpoint
Definition

Indicates the address where the report has to be sent.

ShortIndicates the address where the report has to be sent.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Receiver Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
18. PlanDefinition.extension:asyncIndicator
Slice NameasyncIndicator
Definition

A value of true indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously.

ShortUS Public Health Async Indicator Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
20. PlanDefinition.extension:contentEncrypted
Slice NamecontentEncrypted
Definition

Indicates whether the data in the content bundle is encrypted or not.

ShortUS Public Health Data Encrypted Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
22. PlanDefinition.extension:jwksForContentEncryption
Slice NamejwksForContentEncryption
Definition

Indicates the location of the public key to be used for encryption when submitting data to the Data Receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Invariantsele-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:contentEncryptionAlgorithm
Slice NamecontentEncryptionAlgorithm
Definition

Indicates the algorithms that would be acceptable for encryption of the data prior to submitting to the Data Receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Data Encryption Algorithm) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
26. PlanDefinition.extension:expectedResponseDuration
Slice NameexpectedResponseDuration
Definition

Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination.

ShortUS Public Health Expected Response Time Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
28. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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())
30. 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 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.

ShortCanonical 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.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the plan definition to be referenced by a single globally unique identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. PlanDefinition.identifier
Definition

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the plan definition
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. 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.

ShortBusiness 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].

NoteThis is a business versionId, not a resource version id (see discussion)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. 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.

ShortName 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.

Control1..1
This element is affected by the following invariants: inv-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.title
Definition

A short, descriptive, user-friendly title for the plan definition.

ShortName for this plan definition (human friendly)
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.subtitle
Definition

An explanatory or alternate title for the plan definition giving additional information about its content.

ShortSubordinate title of the plan definition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.type
Definition

Type of this PlanDefinition

ShortType of this PlanDefinition
Control1..1
BindingUnless not suitable, these codes SHALL be taken from PlanDefinitionType

The type of PlanDefinition.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://terminology.hl7.org/CodeSystem/plan-definition-type&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;workflow-definition&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;display&nbsp;value=&quot;Workflow&nbsp;Definition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.status
Definition

The status of this plan definition. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. 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.

ShortFor testing purposes, not real usage
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the plan definition.

ShortType of individual the plan definition is focused on
Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.date
Definition

Date the PlanDefinition was last changed

ShortDate the PlanDefinition was last changed
Comments

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.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PlanDefinition.publisher
Definition

Name of the agency that published this PlanDefinition

ShortName of the agency that published this PlanDefinition
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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

Alternate Namessteward
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a telephone number, etc.

Control0..*
TypeContactDetail
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PlanDefinition.description
Definition

A free text natural language description of the plan definition from a consumer's perspective.

ShortNatural language description of the plan definition
Comments

This description can be used to capture details such as why the plan definition was built, 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).

Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namesscope
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PlanDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

ShortThe context that the content is intended to support
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PlanDefinition.jurisdiction
Definition

A legal or geographic region in which the plan definition is intended to be used.

ShortIntended jurisdiction for plan definition (if applicable)
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet

Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.purpose
Definition

Explanation of why this plan definition is needed and why it has been designed as it has.

ShortWhy this plan definition is defined
Comments

This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.usage
Definition

A detailed description of how the plan definition is used from a clinical perspective.

ShortDescribes the clinical usage of the plan
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.copyright
Definition

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

ShortUse and/or publishing restrictions
Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.

Alternate NamesLicense, Restrictions
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PlanDefinition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen the plan definition was approved by publisher
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

ShortWhen the plan definition was last reviewed
Comments

If specified, this date follows the original approval date.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PlanDefinition.effectivePeriod
Definition

The period during which the PlanDefinition is valid

ShortWhen the PlanDefinition is valid
Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PlanDefinition.effectivePeriod.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. PlanDefinition.effectivePeriod.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.effectivePeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. PlanDefinition.effectivePeriod.start
Definition

The start of the time period when this PlanDefinition goes into effect

ShortThe start of the time period when this PlanDefinition goes into effect
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Control1..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PlanDefinition.effectivePeriod.end
Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

ShortEnd time with inclusive boundary, if not ongoing
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Control0..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.topic
Definition

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

ShortE.g. Education, Treatment, Assessment
Control0..*
BindingFor example codes, see DefinitionTopic

High-level categorization of the definition, used for searching, sorting, and filtering.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PlanDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

ShortWho authored the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. PlanDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

ShortWho edited the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. PlanDefinition.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

ShortWho reviewed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PlanDefinition.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

ShortWho endorsed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. PlanDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

ShortAdditional documentation, citations
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PlanDefinition.library
Definition

A reference to a Library resource containing any formal logic used by the plan definition.

ShortLogic used by the plan definition
Control0..*
Typecanonical(Library)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. PlanDefinition.goal
Definition

Goals that describe what the 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, etc.

ShortWhat the plan is trying to accomplish
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
100. PlanDefinition.goal.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
102. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
104. PlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

ShortE.g. Treatment, dietary, behavioral
Control0..1
BindingFor example codes, see GoalCategory

Example codes for grouping goals for filtering or presentation.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. 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".

ShortCode or text describing the goal
Comments

If no code is available, use CodeableConcept.text.

Control1..1
BindingFor example codes, see SNOMEDCTClinicalFindings

Describes goals that can be achieved.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. PlanDefinition.goal.priority
Definition

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

Shorthigh-priority | medium-priority | low-priority
Control0..1
BindingThe codes SHOULD be taken from GoalPriority

Indicates the level of importance associated with reaching or sustaining a goal.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. PlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

ShortWhen goal pursuit begins
Control0..1
BindingFor example codes, see GoalStartEvent

Identifies the types of events that might trigger the start of a goal.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. PlanDefinition.goal.addresses
Definition

Identifies problems, conditions, issues, or concerns the goal is intended to address.

ShortWhat does the goal address
Control0..*
BindingFor example codes, see Condition/Problem/DiagnosisCodes

Identifies problems, conditions, issues, or concerns that goals may address.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. PlanDefinition.goal.documentation
Definition

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

ShortSupporting documentation for the goal
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. PlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

ShortTarget outcome for the goal
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. PlanDefinition.goal.target.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
120. PlanDefinition.goal.target.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
122. PlanDefinition.goal.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
124. PlanDefinition.goal.target.measure
Definition

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

ShortThe parameter whose value is to be tracked
Control0..1
BindingFor example codes, see LOINCCodes

Identifies types of parameters that can be tracked to determine goal achievement.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. PlanDefinition.goal.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%. 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.

ShortThe target value to be achieved
Control0..1
TypeChoice of: Quantity, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. PlanDefinition.goal.target.due
Definition

Indicates the timeframe after the start of the goal in which the goal should be met.

ShortReach goal within
Control0..1
TypeDuration
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. PlanDefinition.action
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.
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.

Control6..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are ordered and Open, and can be differentiated using the following discriminators:
  • value @ id
132. PlanDefinition.action.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
134. PlanDefinition.action.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. PlanDefinition.action.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
140. PlanDefinition.action.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. PlanDefinition.action.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. PlanDefinition.action.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. PlanDefinition.action.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. PlanDefinition.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. PlanDefinition.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. PlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. 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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. PlanDefinition.action.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. PlanDefinition.action.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. PlanDefinition.action.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
164. PlanDefinition.action.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
166. PlanDefinition.action.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. PlanDefinition.action.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. PlanDefinition.action.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. PlanDefinition.action.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. PlanDefinition.action.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. PlanDefinition.action.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. PlanDefinition.action.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
182. PlanDefinition.action.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
184. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
186. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. PlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. PlanDefinition.action.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
192. PlanDefinition.action.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
194. PlanDefinition.action.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. PlanDefinition.action.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. PlanDefinition.action.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. PlanDefinition.action.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. PlanDefinition.action.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. PlanDefinition.action.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
208. PlanDefinition.action.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
210. PlanDefinition.action.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
212. PlanDefinition.action.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
214. PlanDefinition.action.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. PlanDefinition.action.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. PlanDefinition.action.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. PlanDefinition.action.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. PlanDefinition.action.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. PlanDefinition.action.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
226. PlanDefinition.action.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
228. PlanDefinition.action.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. PlanDefinition.action.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
232. PlanDefinition.action.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. PlanDefinition.action.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. PlanDefinition.action.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. PlanDefinition.action.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
240. PlanDefinition.action.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
242. PlanDefinition.action.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. PlanDefinition.action.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
246. PlanDefinition.action.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. PlanDefinition.action.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. PlanDefinition.action.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. PlanDefinition.action.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
254. PlanDefinition.action.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
256. PlanDefinition.action.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. PlanDefinition.action.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. PlanDefinition.action.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
264. PlanDefinition.action.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
266. PlanDefinition.action.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. PlanDefinition.action.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. PlanDefinition.action.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. PlanDefinition.action.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. PlanDefinition.action.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. PlanDefinition.action.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
278. PlanDefinition.action.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
280. PlanDefinition.action.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. PlanDefinition.action.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
284. PlanDefinition.action.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
286. PlanDefinition.action.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. PlanDefinition.action.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. PlanDefinition.action.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
292. PlanDefinition.action.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
294. PlanDefinition.action.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. PlanDefinition.action.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. PlanDefinition.action.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. PlanDefinition.action.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. PlanDefinition.action.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. PlanDefinition.action.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
306. PlanDefinition.action.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
308. PlanDefinition.action.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. PlanDefinition.action.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. PlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. PlanDefinition.action.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
316. PlanDefinition.action.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
320. PlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. PlanDefinition.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
326. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
328. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
330. PlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
332. PlanDefinition.action.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
334. PlanDefinition.action.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
336. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
340. PlanDefinition.action.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. PlanDefinition.action.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. PlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. PlanDefinition.action.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
350. PlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
352. PlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. PlanDefinition.action.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
356. PlanDefinition.action.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
358. 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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
360. PlanDefinition.action.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
362. PlanDefinition.action.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
364. 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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
366. 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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
368. PlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. 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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. PlanDefinition.action:startWorkflow
Slice NamestartWorkflow
Definition

Defines the "startr" action

ShortStart Workflow Action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
374. PlanDefinition.action:startWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuestart-workflow
376. PlanDefinition.action:startWorkflow.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
378. PlanDefinition.action:startWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
380. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
382. PlanDefinition.action:startWorkflow.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. PlanDefinition.action:startWorkflow.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. PlanDefinition.action:startWorkflow.description
Definition

Description of the start workflow action.

ShortStarts the workflow
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the reporting workflow in response to the encounter-end event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. PlanDefinition.action:startWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.

ShortText equivalent of the start workflow action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueStart the reporting workflow in response to an encounter-end event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
390. PlanDefinition.action:startWorkflow.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
392. PlanDefinition.action:startWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
394. PlanDefinition.action:startWorkflow.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
396. PlanDefinition.action:startWorkflow.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
398. PlanDefinition.action:startWorkflow.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
400. PlanDefinition.action:startWorkflow.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
402. PlanDefinition.action:startWorkflow.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
404. PlanDefinition.action:startWorkflow.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
406. PlanDefinition.action:startWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
408. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
410. PlanDefinition.action:startWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
412. PlanDefinition.action:startWorkflow.trigger.name
Definition

The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valueencounter-end
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
414. PlanDefinition.action:startWorkflow.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
416. PlanDefinition.action:startWorkflow.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
418. PlanDefinition.action:startWorkflow.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. PlanDefinition.action:startWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
422. PlanDefinition.action:startWorkflow.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
424. PlanDefinition.action:startWorkflow.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
426. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
428. PlanDefinition.action:startWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
430. PlanDefinition.action:startWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
432. PlanDefinition.action:startWorkflow.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
434. PlanDefinition.action:startWorkflow.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
436. PlanDefinition.action:startWorkflow.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
438. PlanDefinition.action:startWorkflow.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
440. PlanDefinition.action:startWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
442. PlanDefinition.action:startWorkflow.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
444. PlanDefinition.action:startWorkflow.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
446. PlanDefinition.action:startWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
448. PlanDefinition.action:startWorkflow.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
450. PlanDefinition.action:startWorkflow.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
452. PlanDefinition.action:startWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
454. PlanDefinition.action:startWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
456. PlanDefinition.action:startWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
458. PlanDefinition.action:startWorkflow.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
460. PlanDefinition.action:startWorkflow.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
462. PlanDefinition.action:startWorkflow.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
464. PlanDefinition.action:startWorkflow.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
466. PlanDefinition.action:startWorkflow.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
468. PlanDefinition.action:startWorkflow.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
470. PlanDefinition.action:startWorkflow.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
472. PlanDefinition.action:startWorkflow.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
474. PlanDefinition.action:startWorkflow.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
476. PlanDefinition.action:startWorkflow.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
478. PlanDefinition.action:startWorkflow.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
480. PlanDefinition.action:startWorkflow.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
482. PlanDefinition.action:startWorkflow.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
484. PlanDefinition.action:startWorkflow.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
486. PlanDefinition.action:startWorkflow.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
488. PlanDefinition.action:startWorkflow.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
490. PlanDefinition.action:startWorkflow.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
492. PlanDefinition.action:startWorkflow.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
494. PlanDefinition.action:startWorkflow.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
496. PlanDefinition.action:startWorkflow.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
498. PlanDefinition.action:startWorkflow.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
500. PlanDefinition.action:startWorkflow.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
502. PlanDefinition.action:startWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
504. PlanDefinition.action:startWorkflow.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
506. PlanDefinition.action:startWorkflow.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
508. PlanDefinition.action:startWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
510. PlanDefinition.action:startWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
512. PlanDefinition.action:startWorkflow.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
514. PlanDefinition.action:startWorkflow.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
516. PlanDefinition.action:startWorkflow.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
518. PlanDefinition.action:startWorkflow.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
520. PlanDefinition.action:startWorkflow.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
522. PlanDefinition.action:startWorkflow.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
524. PlanDefinition.action:startWorkflow.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
526. PlanDefinition.action:startWorkflow.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
528. PlanDefinition.action:startWorkflow.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
530. PlanDefinition.action:startWorkflow.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
532. PlanDefinition.action:startWorkflow.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
534. PlanDefinition.action:startWorkflow.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
536. PlanDefinition.action:startWorkflow.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
538. PlanDefinition.action:startWorkflow.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
540. PlanDefinition.action:startWorkflow.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
542. PlanDefinition.action:startWorkflow.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
544. PlanDefinition.action:startWorkflow.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
546. PlanDefinition.action:startWorkflow.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
548. PlanDefinition.action:startWorkflow.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
550. PlanDefinition.action:startWorkflow.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
552. PlanDefinition.action:startWorkflow.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
554. PlanDefinition.action:startWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
556. PlanDefinition.action:startWorkflow.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
558. PlanDefinition.action:startWorkflow.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
560. PlanDefinition.action:startWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
562. PlanDefinition.action:startWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuecheck-reportability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
564. PlanDefinition.action:startWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
566. PlanDefinition.action:startWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
568. PlanDefinition.action:startWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Example<br/><b>Wait 72 hour before next action.</b>:&lt;valueDuration&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;value&nbsp;value=&quot;72&quot;/&gt;<br/>&nbsp;&nbsp;&lt;unit&nbsp;value=&quot;h&quot;/&gt;<br/>&lt;/valueDuration&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
570. PlanDefinition.action:startWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
572. PlanDefinition.action:startWorkflow.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
574. PlanDefinition.action:startWorkflow.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
576. PlanDefinition.action:startWorkflow.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
578. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
580. PlanDefinition.action:startWorkflow.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
582. PlanDefinition.action:startWorkflow.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
584. PlanDefinition.action:startWorkflow.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
586. PlanDefinition.action:startWorkflow.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
588. PlanDefinition.action:startWorkflow.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
590. PlanDefinition.action:startWorkflow.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
592. PlanDefinition.action:startWorkflow.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
594. PlanDefinition.action:startWorkflow.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
596. PlanDefinition.action:startWorkflow.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
598. PlanDefinition.action:startWorkflow.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
600. PlanDefinition.action:startWorkflow.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
602. PlanDefinition.action:startWorkflow.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
604. PlanDefinition.action:startWorkflow.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
606. PlanDefinition.action:startWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
608. PlanDefinition.action:startWorkflow.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
610. PlanDefinition.action:startWorkflow.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
612. PlanDefinition.action:startWorkflow.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
614. PlanDefinition.action:positiveLabResultWorkflow
Slice NamepositiveLabResultWorkflow
Definition

Defines the "startr" action

ShortStart Workflow Action due to a positive lab result
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
616. PlanDefinition.action:positiveLabResultWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuestart-workflow-for-positive-lab-result
618. PlanDefinition.action:positiveLabResultWorkflow.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
620. PlanDefinition.action:positiveLabResultWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
622. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
624. PlanDefinition.action:positiveLabResultWorkflow.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
626. PlanDefinition.action:positiveLabResultWorkflow.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
628. PlanDefinition.action:positiveLabResultWorkflow.description
Definition

Description of the start workflow action.

ShortStarts the workflow due to a positive lab result
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
630. PlanDefinition.action:positiveLabResultWorkflow.textEquivalent
Definition

Text equivalent of the start workflow action.

ShortText equivalent of the start workflow action for positive lab result.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueStart the reporting workflow in response to an labresult-change event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
632. PlanDefinition.action:positiveLabResultWorkflow.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
634. PlanDefinition.action:positiveLabResultWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;initiate-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
636. PlanDefinition.action:positiveLabResultWorkflow.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
638. PlanDefinition.action:positiveLabResultWorkflow.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
640. PlanDefinition.action:positiveLabResultWorkflow.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
642. PlanDefinition.action:positiveLabResultWorkflow.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
644. PlanDefinition.action:positiveLabResultWorkflow.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
646. PlanDefinition.action:positiveLabResultWorkflow.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
648. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
650. PlanDefinition.action:positiveLabResultWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
652. PlanDefinition.action:positiveLabResultWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
654. PlanDefinition.action:positiveLabResultWorkflow.trigger.name
Definition

The name of the event, labresult-change in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable $labresult

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuelabresult-change
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
656. PlanDefinition.action:positiveLabResultWorkflow.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
658. PlanDefinition.action:positiveLabResultWorkflow.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
660. PlanDefinition.action:positiveLabResultWorkflow.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
662. PlanDefinition.action:positiveLabResultWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
664. PlanDefinition.action:positiveLabResultWorkflow.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
666. PlanDefinition.action:positiveLabResultWorkflow.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
668. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
670. PlanDefinition.action:positiveLabResultWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
672. PlanDefinition.action:positiveLabResultWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
674. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
676. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
678. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
680. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
682. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
684. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
686. PlanDefinition.action:positiveLabResultWorkflow.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
688. PlanDefinition.action:positiveLabResultWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
690. PlanDefinition.action:positiveLabResultWorkflow.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
692. PlanDefinition.action:positiveLabResultWorkflow.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
694. PlanDefinition.action:positiveLabResultWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
696. PlanDefinition.action:positiveLabResultWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
698. PlanDefinition.action:positiveLabResultWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
700. PlanDefinition.action:positiveLabResultWorkflow.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
702. PlanDefinition.action:positiveLabResultWorkflow.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
704. PlanDefinition.action:positiveLabResultWorkflow.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
706. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
708. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
710. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
712. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
714. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
716. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
718. PlanDefinition.action:positiveLabResultWorkflow.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
720. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
722. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
724. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
726. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
728. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
730. PlanDefinition.action:positiveLabResultWorkflow.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
732. PlanDefinition.action:positiveLabResultWorkflow.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
734. PlanDefinition.action:positiveLabResultWorkflow.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
736. PlanDefinition.action:positiveLabResultWorkflow.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
738. PlanDefinition.action:positiveLabResultWorkflow.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
740. PlanDefinition.action:positiveLabResultWorkflow.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
742. PlanDefinition.action:positiveLabResultWorkflow.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
744. PlanDefinition.action:positiveLabResultWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
746. PlanDefinition.action:positiveLabResultWorkflow.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
748. PlanDefinition.action:positiveLabResultWorkflow.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
750. PlanDefinition.action:positiveLabResultWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
752. PlanDefinition.action:positiveLabResultWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
754. PlanDefinition.action:positiveLabResultWorkflow.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
756. PlanDefinition.action:positiveLabResultWorkflow.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
758. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
760. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
762. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
764. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
766. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
768. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
770. PlanDefinition.action:positiveLabResultWorkflow.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
772. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
774. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
776. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
778. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
780. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
782. PlanDefinition.action:positiveLabResultWorkflow.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
784. PlanDefinition.action:positiveLabResultWorkflow.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
786. PlanDefinition.action:positiveLabResultWorkflow.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
788. PlanDefinition.action:positiveLabResultWorkflow.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
790. PlanDefinition.action:positiveLabResultWorkflow.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
792. PlanDefinition.action:positiveLabResultWorkflow.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
794. PlanDefinition.action:positiveLabResultWorkflow.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
796. PlanDefinition.action:positiveLabResultWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
798. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
800. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
802. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
804. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuecheck-reportability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
806. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
808. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
810. PlanDefinition.action:positiveLabResultWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
812. PlanDefinition.action:positiveLabResultWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
814. PlanDefinition.action:positiveLabResultWorkflow.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
816. PlanDefinition.action:positiveLabResultWorkflow.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
818. PlanDefinition.action:positiveLabResultWorkflow.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
820. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
822. PlanDefinition.action:positiveLabResultWorkflow.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
824. PlanDefinition.action:positiveLabResultWorkflow.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
826. PlanDefinition.action:positiveLabResultWorkflow.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
828. PlanDefinition.action:positiveLabResultWorkflow.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
830. PlanDefinition.action:positiveLabResultWorkflow.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
832. PlanDefinition.action:positiveLabResultWorkflow.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
834. PlanDefinition.action:positiveLabResultWorkflow.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
836. PlanDefinition.action:positiveLabResultWorkflow.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
838. PlanDefinition.action:positiveLabResultWorkflow.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
840. PlanDefinition.action:positiveLabResultWorkflow.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
842. PlanDefinition.action:positiveLabResultWorkflow.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
844. PlanDefinition.action:positiveLabResultWorkflow.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
846. PlanDefinition.action:positiveLabResultWorkflow.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
848. PlanDefinition.action:positiveLabResultWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
850. PlanDefinition.action:positiveLabResultWorkflow.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
852. PlanDefinition.action:positiveLabResultWorkflow.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
854. PlanDefinition.action:positiveLabResultWorkflow.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
856. PlanDefinition.action:executeReportingWorkflow
Slice NameexecuteReportingWorkflow
Definition

Defines the "Execute Reporting Workflow" action

ShortExecute Reporting Workflow
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
858. PlanDefinition.action:executeReportingWorkflow.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuecheck-reportability
860. PlanDefinition.action:executeReportingWorkflow.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
862. PlanDefinition.action:executeReportingWorkflow.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
864. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
866. PlanDefinition.action:executeReportingWorkflow.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
868. PlanDefinition.action:executeReportingWorkflow.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
870. PlanDefinition.action:executeReportingWorkflow.description
Definition

Check for Reportable Conditions.

ShortCheck for reportability conditions
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
872. PlanDefinition.action:executeReportingWorkflow.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
874. PlanDefinition.action:executeReportingWorkflow.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
876. PlanDefinition.action:executeReportingWorkflow.code
Definition

The US-PH-PlanDefinition-Action code for the "execute-reporting-workflow" action.

ShortCode for the "execute-reporting-workflow" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;execute-reporting-workflow&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
878. PlanDefinition.action:executeReportingWorkflow.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
880. PlanDefinition.action:executeReportingWorkflow.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
882. PlanDefinition.action:executeReportingWorkflow.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
884. PlanDefinition.action:executeReportingWorkflow.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
886. PlanDefinition.action:executeReportingWorkflow.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
888. PlanDefinition.action:executeReportingWorkflow.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
890. PlanDefinition.action:executeReportingWorkflow.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
892. PlanDefinition.action:executeReportingWorkflow.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
894. PlanDefinition.action:executeReportingWorkflow.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
896. PlanDefinition.action:executeReportingWorkflow.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
898. PlanDefinition.action:executeReportingWorkflow.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
900. PlanDefinition.action:executeReportingWorkflow.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
902. PlanDefinition.action:executeReportingWorkflow.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
904. PlanDefinition.action:executeReportingWorkflow.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
906. PlanDefinition.action:executeReportingWorkflow.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
908. PlanDefinition.action:executeReportingWorkflow.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
910. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
912. PlanDefinition.action:executeReportingWorkflow.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
914. PlanDefinition.action:executeReportingWorkflow.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
916. PlanDefinition.action:executeReportingWorkflow.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
918. PlanDefinition.action:executeReportingWorkflow.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
920. PlanDefinition.action:executeReportingWorkflow.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
922. PlanDefinition.action:executeReportingWorkflow.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
924. PlanDefinition.action:executeReportingWorkflow.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
926. PlanDefinition.action:executeReportingWorkflow.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
928. PlanDefinition.action:executeReportingWorkflow.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
930. PlanDefinition.action:executeReportingWorkflow.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
932. PlanDefinition.action:executeReportingWorkflow.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
934. PlanDefinition.action:executeReportingWorkflow.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
936. PlanDefinition.action:executeReportingWorkflow.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
938. PlanDefinition.action:executeReportingWorkflow.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
940. PlanDefinition.action:executeReportingWorkflow.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
942. PlanDefinition.action:executeReportingWorkflow.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
944. PlanDefinition.action:executeReportingWorkflow.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
946. PlanDefinition.action:executeReportingWorkflow.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
948. PlanDefinition.action:executeReportingWorkflow.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
950. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
952. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
954. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
956. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
958. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
960. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
962. PlanDefinition.action:executeReportingWorkflow.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
964. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
966. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
968. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
970. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
972. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
974. PlanDefinition.action:executeReportingWorkflow.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
976. PlanDefinition.action:executeReportingWorkflow.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
978. PlanDefinition.action:executeReportingWorkflow.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
980. PlanDefinition.action:executeReportingWorkflow.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
982. PlanDefinition.action:executeReportingWorkflow.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
984. PlanDefinition.action:executeReportingWorkflow.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
986. PlanDefinition.action:executeReportingWorkflow.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
988. PlanDefinition.action:executeReportingWorkflow.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
990. PlanDefinition.action:executeReportingWorkflow.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
992. PlanDefinition.action:executeReportingWorkflow.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
994. PlanDefinition.action:executeReportingWorkflow.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
996. PlanDefinition.action:executeReportingWorkflow.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
998. PlanDefinition.action:executeReportingWorkflow.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1000. PlanDefinition.action:executeReportingWorkflow.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1002. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1004. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1006. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1008. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1010. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1012. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1014. PlanDefinition.action:executeReportingWorkflow.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1016. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1018. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1020. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1022. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1024. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1026. PlanDefinition.action:executeReportingWorkflow.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1028. PlanDefinition.action:executeReportingWorkflow.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1030. PlanDefinition.action:executeReportingWorkflow.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1032. PlanDefinition.action:executeReportingWorkflow.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1034. PlanDefinition.action:executeReportingWorkflow.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1036. PlanDefinition.action:executeReportingWorkflow.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1038. PlanDefinition.action:executeReportingWorkflow.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1040. PlanDefinition.action:executeReportingWorkflow.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1042. PlanDefinition.action:executeReportingWorkflow.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1044. PlanDefinition.action:executeReportingWorkflow.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1046. PlanDefinition.action:executeReportingWorkflow.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1048. PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1050. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
1052. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1054. PlanDefinition.action:executeReportingWorkflow.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1056. PlanDefinition.action:executeReportingWorkflow.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1058. PlanDefinition.action:executeReportingWorkflow.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1060. PlanDefinition.action:executeReportingWorkflow.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1062. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1064. PlanDefinition.action:executeReportingWorkflow.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1066. PlanDefinition.action:executeReportingWorkflow.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1068. PlanDefinition.action:executeReportingWorkflow.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1070. PlanDefinition.action:executeReportingWorkflow.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1072. PlanDefinition.action:executeReportingWorkflow.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1074. PlanDefinition.action:executeReportingWorkflow.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1076. PlanDefinition.action:executeReportingWorkflow.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1078. PlanDefinition.action:executeReportingWorkflow.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1080. PlanDefinition.action:executeReportingWorkflow.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1082. PlanDefinition.action:executeReportingWorkflow.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1084. PlanDefinition.action:executeReportingWorkflow.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1086. PlanDefinition.action:executeReportingWorkflow.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1088. PlanDefinition.action:executeReportingWorkflow.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1090. PlanDefinition.action:executeReportingWorkflow.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1092. PlanDefinition.action:executeReportingWorkflow.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1094. PlanDefinition.action:executeReportingWorkflow.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1096. PlanDefinition.action:executeReportingWorkflow.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.

ShortA sub-action
Control2..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
1098. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice NameisAmbulatoryEncounterReportable
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1100. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valueis-ambulatory-encounter-reportable
1102. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1104. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1106. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1108. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1110. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1112. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1114. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1116. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..1
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1118. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1120. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1122. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1124. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1126. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1128. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1130. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1132. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1134. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1136. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1138. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1140. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1142. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1144. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1146. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1148. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1150. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1152. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1154. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1156. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1158. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1160. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1162. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1164. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1166. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1168. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1170. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1172. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1174. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1176. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1178. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1180. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1182. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1184. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1186. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1188. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1190. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1192. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1194. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1196. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1198. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1200. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1202. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1204. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1206. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1208. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1210. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1212. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1214. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1216. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuecreate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1218. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1220. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1222. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1224. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1226. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1228. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1230. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1232. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1234. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1236. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1238. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1240. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1242. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1244. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1246. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1248. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1250. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1252. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1254. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1256. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1258. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1260. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1262. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1264. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1266. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice NameisInpatientEncounterReportable
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1268. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valueis-inpatient-encounter-reportable
1270. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1272. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1274. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1276. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1278. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1280. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1282. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1284. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..1
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;evaluate-condition&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1286. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1288. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1290. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1292. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1294. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1296. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1298. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1300. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1302. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1304. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1306. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1308. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1310. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1312. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1314. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1316. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1318. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1320. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1322. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1324. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1326. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1328. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1330. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1332. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1334. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1336. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1338. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1340. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1342. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1344. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1346. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1348. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1350. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1352. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1354. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1356. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1358. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1360. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1362. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1364. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1366. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1368. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1370. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1372. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1374. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1376. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1378. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1380. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1382. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1384. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuecreate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1386. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1388. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1390. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1392. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1394. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1396. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1398. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1400. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1402. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1404. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1406. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1408. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1410. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1412. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1414. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1416. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1418. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1420. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1422. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1424. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1426. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1428. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1430. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1432. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1434. PlanDefinition.action:createReport
Slice NamecreateReport
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1436. PlanDefinition.action:createReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuecreate-resp-net-report
1438. PlanDefinition.action:createReport.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1440. PlanDefinition.action:createReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
1442. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1444. PlanDefinition.action:createReport.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1446. PlanDefinition.action:createReport.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1448. PlanDefinition.action:createReport.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the creation, validation and submission of the RESP-NET report.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1450. PlanDefinition.action:createReport.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1452. PlanDefinition.action:createReport.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1454. PlanDefinition.action:createReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;create-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1456. PlanDefinition.action:createReport.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1458. PlanDefinition.action:createReport.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1460. PlanDefinition.action:createReport.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1462. PlanDefinition.action:createReport.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1464. PlanDefinition.action:createReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1466. PlanDefinition.action:createReport.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1468. PlanDefinition.action:createReport.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1470. PlanDefinition.action:createReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1472. PlanDefinition.action:createReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1474. PlanDefinition.action:createReport.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1476. PlanDefinition.action:createReport.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1478. PlanDefinition.action:createReport.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1480. PlanDefinition.action:createReport.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1482. PlanDefinition.action:createReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1484. PlanDefinition.action:createReport.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1486. PlanDefinition.action:createReport.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1488. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1490. PlanDefinition.action:createReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1492. PlanDefinition.action:createReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1494. PlanDefinition.action:createReport.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1496. PlanDefinition.action:createReport.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1498. PlanDefinition.action:createReport.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1500. PlanDefinition.action:createReport.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1502. PlanDefinition.action:createReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1504. PlanDefinition.action:createReport.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1506. PlanDefinition.action:createReport.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1508. PlanDefinition.action:createReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1510. PlanDefinition.action:createReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1512. PlanDefinition.action:createReport.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1514. PlanDefinition.action:createReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1516. PlanDefinition.action:createReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1518. PlanDefinition.action:createReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1520. PlanDefinition.action:createReport.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1522. PlanDefinition.action:createReport.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1524. PlanDefinition.action:createReport.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1526. PlanDefinition.action:createReport.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1528. PlanDefinition.action:createReport.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1530. PlanDefinition.action:createReport.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1532. PlanDefinition.action:createReport.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1534. PlanDefinition.action:createReport.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1536. PlanDefinition.action:createReport.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1538. PlanDefinition.action:createReport.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1540. PlanDefinition.action:createReport.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1542. PlanDefinition.action:createReport.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1544. PlanDefinition.action:createReport.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1546. PlanDefinition.action:createReport.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1548. PlanDefinition.action:createReport.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1550. PlanDefinition.action:createReport.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1552. PlanDefinition.action:createReport.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1554. PlanDefinition.action:createReport.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1556. PlanDefinition.action:createReport.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1558. PlanDefinition.action:createReport.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1560. PlanDefinition.action:createReport.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1562. PlanDefinition.action:createReport.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1564. PlanDefinition.action:createReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1566. PlanDefinition.action:createReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1568. PlanDefinition.action:createReport.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1570. PlanDefinition.action:createReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1572. PlanDefinition.action:createReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1574. PlanDefinition.action:createReport.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1576. PlanDefinition.action:createReport.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1578. PlanDefinition.action:createReport.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1580. PlanDefinition.action:createReport.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1582. PlanDefinition.action:createReport.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1584. PlanDefinition.action:createReport.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1586. PlanDefinition.action:createReport.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1588. PlanDefinition.action:createReport.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1590. PlanDefinition.action:createReport.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1592. PlanDefinition.action:createReport.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1594. PlanDefinition.action:createReport.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1596. PlanDefinition.action:createReport.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1598. PlanDefinition.action:createReport.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1600. PlanDefinition.action:createReport.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1602. PlanDefinition.action:createReport.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1604. PlanDefinition.action:createReport.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1606. PlanDefinition.action:createReport.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1608. PlanDefinition.action:createReport.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1610. PlanDefinition.action:createReport.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1612. PlanDefinition.action:createReport.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1614. PlanDefinition.action:createReport.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1616. PlanDefinition.action:createReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1618. PlanDefinition.action:createReport.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1620. PlanDefinition.action:createReport.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1622. PlanDefinition.action:createReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1624. PlanDefinition.action:createReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuevalidate-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1626. PlanDefinition.action:createReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1628. PlanDefinition.action:createReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
1630. PlanDefinition.action:createReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1632. PlanDefinition.action:createReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1634. PlanDefinition.action:createReport.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1636. PlanDefinition.action:createReport.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1638. PlanDefinition.action:createReport.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1640. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1642. PlanDefinition.action:createReport.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1644. PlanDefinition.action:createReport.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1646. PlanDefinition.action:createReport.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1648. PlanDefinition.action:createReport.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1650. PlanDefinition.action:createReport.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1652. PlanDefinition.action:createReport.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1654. PlanDefinition.action:createReport.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1656. PlanDefinition.action:createReport.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1658. PlanDefinition.action:createReport.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1660. PlanDefinition.action:createReport.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1662. PlanDefinition.action:createReport.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1664. PlanDefinition.action:createReport.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1666. PlanDefinition.action:createReport.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1668. PlanDefinition.action:createReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1670. PlanDefinition.action:createReport.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1672. PlanDefinition.action:createReport.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1674. PlanDefinition.action:createReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1676. PlanDefinition.action:validateReport
Slice NamevalidateReport
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1678. PlanDefinition.action:validateReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuevalidate-resp-net-report
1680. PlanDefinition.action:validateReport.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1682. PlanDefinition.action:validateReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
1684. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1686. PlanDefinition.action:validateReport.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1688. PlanDefinition.action:validateReport.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1690. PlanDefinition.action:validateReport.description
Definition

A brief description of the action used to provide a summary to display to the user.

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the validation of the RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1692. PlanDefinition.action:validateReport.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1694. PlanDefinition.action:validateReport.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1696. PlanDefinition.action:validateReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;validate-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1698. PlanDefinition.action:validateReport.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1700. PlanDefinition.action:validateReport.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1702. PlanDefinition.action:validateReport.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1704. PlanDefinition.action:validateReport.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1706. PlanDefinition.action:validateReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1708. PlanDefinition.action:validateReport.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1710. PlanDefinition.action:validateReport.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1712. PlanDefinition.action:validateReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1714. PlanDefinition.action:validateReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1716. PlanDefinition.action:validateReport.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1718. PlanDefinition.action:validateReport.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1720. PlanDefinition.action:validateReport.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1722. PlanDefinition.action:validateReport.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1724. PlanDefinition.action:validateReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1726. PlanDefinition.action:validateReport.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1728. PlanDefinition.action:validateReport.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1730. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1732. PlanDefinition.action:validateReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1734. PlanDefinition.action:validateReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1736. PlanDefinition.action:validateReport.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1738. PlanDefinition.action:validateReport.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1740. PlanDefinition.action:validateReport.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1742. PlanDefinition.action:validateReport.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1744. PlanDefinition.action:validateReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1746. PlanDefinition.action:validateReport.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1748. PlanDefinition.action:validateReport.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1750. PlanDefinition.action:validateReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1752. PlanDefinition.action:validateReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1754. PlanDefinition.action:validateReport.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1756. PlanDefinition.action:validateReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1758. PlanDefinition.action:validateReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1760. PlanDefinition.action:validateReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1762. PlanDefinition.action:validateReport.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1764. PlanDefinition.action:validateReport.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1766. PlanDefinition.action:validateReport.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1768. PlanDefinition.action:validateReport.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1770. PlanDefinition.action:validateReport.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1772. PlanDefinition.action:validateReport.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1774. PlanDefinition.action:validateReport.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1776. PlanDefinition.action:validateReport.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1778. PlanDefinition.action:validateReport.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1780. PlanDefinition.action:validateReport.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1782. PlanDefinition.action:validateReport.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1784. PlanDefinition.action:validateReport.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1786. PlanDefinition.action:validateReport.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1788. PlanDefinition.action:validateReport.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1790. PlanDefinition.action:validateReport.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1792. PlanDefinition.action:validateReport.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1794. PlanDefinition.action:validateReport.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1796. PlanDefinition.action:validateReport.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1798. PlanDefinition.action:validateReport.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1800. PlanDefinition.action:validateReport.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1802. PlanDefinition.action:validateReport.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1804. PlanDefinition.action:validateReport.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1806. PlanDefinition.action:validateReport.output
Definition

Defines output produced by the action. Required data is accessible via a context variable named %[id] using the id of the output data requirement

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1808. PlanDefinition.action:validateReport.output.id
Definition

The id of the output produced, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1810. PlanDefinition.action:validateReport.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1812. PlanDefinition.action:validateReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1814. PlanDefinition.action:validateReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1816. PlanDefinition.action:validateReport.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1818. PlanDefinition.action:validateReport.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1820. PlanDefinition.action:validateReport.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1822. PlanDefinition.action:validateReport.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1824. PlanDefinition.action:validateReport.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1826. PlanDefinition.action:validateReport.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1828. PlanDefinition.action:validateReport.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1830. PlanDefinition.action:validateReport.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1832. PlanDefinition.action:validateReport.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1834. PlanDefinition.action:validateReport.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1836. PlanDefinition.action:validateReport.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1838. PlanDefinition.action:validateReport.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1840. PlanDefinition.action:validateReport.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1842. PlanDefinition.action:validateReport.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1844. PlanDefinition.action:validateReport.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1846. PlanDefinition.action:validateReport.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1848. PlanDefinition.action:validateReport.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1850. PlanDefinition.action:validateReport.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1852. PlanDefinition.action:validateReport.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1854. PlanDefinition.action:validateReport.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1856. PlanDefinition.action:validateReport.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1858. PlanDefinition.action:validateReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1860. PlanDefinition.action:validateReport.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1862. PlanDefinition.action:validateReport.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1864. PlanDefinition.action:validateReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1866. PlanDefinition.action:validateReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuesubmit-resp-net-report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1868. PlanDefinition.action:validateReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1870. PlanDefinition.action:validateReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
1872. PlanDefinition.action:validateReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1874. PlanDefinition.action:validateReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1876. PlanDefinition.action:validateReport.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1878. PlanDefinition.action:validateReport.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1880. PlanDefinition.action:validateReport.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1882. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1884. PlanDefinition.action:validateReport.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1886. PlanDefinition.action:validateReport.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1888. PlanDefinition.action:validateReport.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1890. PlanDefinition.action:validateReport.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1892. PlanDefinition.action:validateReport.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1894. PlanDefinition.action:validateReport.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1896. PlanDefinition.action:validateReport.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1898. PlanDefinition.action:validateReport.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1900. PlanDefinition.action:validateReport.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1902. PlanDefinition.action:validateReport.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1904. PlanDefinition.action:validateReport.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1906. PlanDefinition.action:validateReport.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1908. PlanDefinition.action:validateReport.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1910. PlanDefinition.action:validateReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1912. PlanDefinition.action:validateReport.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1914. PlanDefinition.action:validateReport.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1916. PlanDefinition.action:validateReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1918. PlanDefinition.action:submitRespNetReport
Slice NamesubmitRespNetReport
Definition

Defines the routing and sending of the RESP-NET Report

ShortRoute and send RESP-NET Report
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1920. PlanDefinition.action:submitRespNetReport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuesubmit-resp-net-report
1922. PlanDefinition.action:submitRespNetReport.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1924. PlanDefinition.action:submitRespNetReport.extension:trustServiceEndpoint
Slice NametrustServiceEndpoint
Definition

Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.

ShortIndicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(US Public Health Trust Service Endpoint) (Extension Type: Reference(USPH Endpoint))
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
1926. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1928. PlanDefinition.action:submitRespNetReport.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1930. PlanDefinition.action:submitRespNetReport.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1932. PlanDefinition.action:submitRespNetReport.description
Definition

Description of the route and send action.

ShortDescription of the route and send action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueThis action represents the routing and sending of the RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1934. PlanDefinition.action:submitRespNetReport.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed ValueRoute and send RESP-NET Report
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1936. PlanDefinition.action:submitRespNetReport.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1938. PlanDefinition.action:submitRespNetReport.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health PlanDefinition Action

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;submit-report&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1940. PlanDefinition.action:submitRespNetReport.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy 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.

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1942. PlanDefinition.action:submitRespNetReport.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1944. PlanDefinition.action:submitRespNetReport.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1946. PlanDefinition.action:submitRespNetReport.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1948. PlanDefinition.action:submitRespNetReport.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1950. PlanDefinition.action:submitRespNetReport.trigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1952. PlanDefinition.action:submitRespNetReport.trigger.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1954. PlanDefinition.action:submitRespNetReport.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the Data Source(e.g., EHR)

ShortUS Public Health Named Event Type Extension
Control0..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
1956. PlanDefinition.action:submitRespNetReport.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuenamed-event
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1958. PlanDefinition.action:submitRespNetReport.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1960. PlanDefinition.action:submitRespNetReport.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1962. PlanDefinition.action:submitRespNetReport.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1964. PlanDefinition.action:submitRespNetReport.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1966. PlanDefinition.action:submitRespNetReport.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

ShortWhether 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1968. PlanDefinition.action:submitRespNetReport.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1970. PlanDefinition.action:submitRespNetReport.condition.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
1972. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
1974. PlanDefinition.action:submitRespNetReport.condition.kind
Definition

The kind of condition.

Shortapplicability | 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.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valueapplicability
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1976. PlanDefinition.action:submitRespNetReport.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1978. PlanDefinition.action:submitRespNetReport.condition.expression.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1980. PlanDefinition.action:submitRespNetReport.condition.expression.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1982. PlanDefinition.action:submitRespNetReport.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1984. PlanDefinition.action:submitRespNetReport.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1986. PlanDefinition.action:submitRespNetReport.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valuetext/fhirpath
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1988. PlanDefinition.action:submitRespNetReport.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1990. PlanDefinition.action:submitRespNetReport.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1992. PlanDefinition.action:submitRespNetReport.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1994. PlanDefinition.action:submitRespNetReport.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1996. PlanDefinition.action:submitRespNetReport.input.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1998. PlanDefinition.action:submitRespNetReport.input.extension:defaultQuery
Slice NamedefaultQuery
Definition

What FHIR query pattern?

ShortUS Public Health FHIR Query Pattern Extension
Control0..1
TypeExtension(US Public Health FHIR Query Pattern Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
2000. PlanDefinition.action:submitRespNetReport.input.extension:relatedDataId
Slice NamerelatedDataId
Definition

Points to an existing input or output element that provides data to this input or results as output for the action.

ShortUS Public Health Related Data Extension
Control0..1
TypeExtension(US Public Health Related Data Extension) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
2002. PlanDefinition.action:submitRespNetReport.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2004. PlanDefinition.action:submitRespNetReport.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2006. PlanDefinition.action:submitRespNetReport.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2008. PlanDefinition.action:submitRespNetReport.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2010. PlanDefinition.action:submitRespNetReport.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2012. PlanDefinition.action:submitRespNetReport.input.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2014. PlanDefinition.action:submitRespNetReport.input.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2016. PlanDefinition.action:submitRespNetReport.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2018. PlanDefinition.action:submitRespNetReport.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2020. PlanDefinition.action:submitRespNetReport.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2022. PlanDefinition.action:submitRespNetReport.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2024. PlanDefinition.action:submitRespNetReport.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2026. PlanDefinition.action:submitRespNetReport.input.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2028. PlanDefinition.action:submitRespNetReport.input.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2030. PlanDefinition.action:submitRespNetReport.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2032. PlanDefinition.action:submitRespNetReport.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2034. PlanDefinition.action:submitRespNetReport.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2036. PlanDefinition.action:submitRespNetReport.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2038. PlanDefinition.action:submitRespNetReport.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2040. PlanDefinition.action:submitRespNetReport.input.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2042. PlanDefinition.action:submitRespNetReport.input.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2044. PlanDefinition.action:submitRespNetReport.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2046. PlanDefinition.action:submitRespNetReport.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2048. PlanDefinition.action:submitRespNetReport.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2050. PlanDefinition.action:submitRespNetReport.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2052. PlanDefinition.action:submitRespNetReport.output.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2054. PlanDefinition.action:submitRespNetReport.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2056. PlanDefinition.action:submitRespNetReport.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2058. PlanDefinition.action:submitRespNetReport.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType

The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2060. PlanDefinition.action:submitRespNetReport.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2062. PlanDefinition.action:submitRespNetReport.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2064. PlanDefinition.action:submitRespNetReport.output.codeFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2066. PlanDefinition.action:submitRespNetReport.output.codeFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2068. PlanDefinition.action:submitRespNetReport.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2070. PlanDefinition.action:submitRespNetReport.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2072. PlanDefinition.action:submitRespNetReport.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2074. PlanDefinition.action:submitRespNetReport.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2076. PlanDefinition.action:submitRespNetReport.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2078. PlanDefinition.action:submitRespNetReport.output.dateFilter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2080. PlanDefinition.action:submitRespNetReport.output.dateFilter.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2082. PlanDefinition.action:submitRespNetReport.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2084. PlanDefinition.action:submitRespNetReport.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2086. PlanDefinition.action:submitRespNetReport.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2088. PlanDefinition.action:submitRespNetReport.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2090. PlanDefinition.action:submitRespNetReport.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2092. PlanDefinition.action:submitRespNetReport.output.sort.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2094. PlanDefinition.action:submitRespNetReport.output.sort.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2096. PlanDefinition.action:submitRespNetReport.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2098. PlanDefinition.action:submitRespNetReport.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2100. PlanDefinition.action:submitRespNetReport.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

ShortRelationship to another action
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2102. PlanDefinition.action:submitRespNetReport.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2104. PlanDefinition.action:submitRespNetReport.relatedAction.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
2106. PlanDefinition.action:submitRespNetReport.relatedAction.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
2108. PlanDefinition.action:submitRespNetReport.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2110. PlanDefinition.action:submitRespNetReport.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Valuebefore-start
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2112. PlanDefinition.action:submitRespNetReport.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
2114. PlanDefinition.action:submitRespNetReport.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2116. PlanDefinition.action:submitRespNetReport.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2118. PlanDefinition.action:submitRespNetReport.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2120. PlanDefinition.action:submitRespNetReport.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2122. PlanDefinition.action:submitRespNetReport.participant.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
2124. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
2126. PlanDefinition.action:submitRespNetReport.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2128. PlanDefinition.action:submitRespNetReport.participant.role
Definition

The role the participant should play in performing the described action.

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2130. PlanDefinition.action:submitRespNetReport.type
Definition

The type of action to perform (create, update, remove).

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2132. PlanDefinition.action:submitRespNetReport.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2134. PlanDefinition.action:submitRespNetReport.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2136. PlanDefinition.action:submitRespNetReport.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2138. PlanDefinition.action:submitRespNetReport.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2140. PlanDefinition.action:submitRespNetReport.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2142. PlanDefinition.action:submitRespNetReport.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

ShortDescription 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.

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2144. PlanDefinition.action:submitRespNetReport.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2146. PlanDefinition.action:submitRespNetReport.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.

ShortDynamic 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2148. PlanDefinition.action:submitRespNetReport.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2150. PlanDefinition.action:submitRespNetReport.dynamicValue.extension
Definition

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 manageable, 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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
2152. PlanDefinition.action:submitRespNetReport.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 manageable, 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
2154. PlanDefinition.action:submitRespNetReport.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 resolveable 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).

ShortThe 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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2156. PlanDefinition.action:submitRespNetReport.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn 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.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2158. PlanDefinition.action:submitRespNetReport.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.

ShortA sub-action
Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))