Central Cancer Registry Reporting Content IG
2.0.0-ballot - STU 2 Ballot

Central Cancer Registry Reporting Content IG - Downloaded Version 2.0.0-ballot See the Directory of published versions

## Resource Profile: Central Cancer Registry Reporting PlanDefinition

Official URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition | Version: 2.0.0-ballot
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CentralCancerRegistryReportingPlanDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.40.42.9

This PlanDefinition profile defines the logic and rules around determining whether or not a cancer report should be generated and sent to a cancer registry. If the cancer condition is reportable, the PlanDefinition gives timing information, next steps and instructions for sending the cancer report to the cancer registry. The rules for determining reportability described by the Central Cancer Registry Reporting specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events.

### Introduction

This profile is used to represent the PlanDefinition instance which is an integral part of the Central Cancer Registry Reporting Knowledge Artifact.

#### Requirements of the Knowledge Artifact

- The Central Cancer Registry Reporting PlanDefinition is triggered by an encounter-close event.

- The PlanDefinition specifies a mechanism to run scheduled jobs at specified intervals when the reason for the encounter/visit is to diagnose, evaluate, and/or treat an active cancer and create a cancer report.

  - Encounter of ICD-10-CM or SNOMED CT Reportable Codes

- The PlanDefinition specifies a mechanism to run scheduled jobs at least every 6 months for the patient and create a cancer report.

- The PlanDefinition specifies a mechanism to run scheduled jobs once every 12 months until the patient is deceased or there is no updates to the record for 24 months and create a cancer report.

Usages:

- Examples for this Profile: CentralCancerRegistryReportingExample

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S C | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting Constraints: pdf-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
extension:asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
extension:contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
extension:jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
extension:contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
extension:expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the plan definition
version | S Σ | 1..1 | string | Business version of the PlanDefinition
name | S Σ C | 1..1 | string | Name for this PlanDefinition (computer friendly)
title | S Σ | 1..1 | string | Title for this PlanDefinition
type | S Σ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition
display |  | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage
subject[x] | S | 0..1 |  | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 1..1 | dateTime | Date the PlanDefinition was last changed
publisher | S Σ | 1..1 | string | Name of the agency that published this PlanDefinition
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the plan definition
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
effectivePeriod | S Σ | 0..1 | Period | When the PlanDefinition is valid
start | Σ C | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect
library | S | 0..* | canonical(Library) | Logic used by the plan definition
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Brief description of the action
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Closed by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
timing[x] | S | 0..1 | Duration | When the action should take place
action:checkReportable | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
action:reportCancerData | S | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📦4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:encounterClose.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:checkReportable.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:reportCancerData.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | 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 | error | PlanDefinition | 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 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | 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}')`

This structure is derived from USPublicHealthPlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
input |  | 0..* | DataRequirement | Input data requirements
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
code | S | 1..1 | CodeableConcept | Code for the "start" action. Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type |  | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event
name |  | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
action:checkReportable |  | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
description |  | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
kind |  | 1..1 | code | applicability | start | stop Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language |  | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
relatedAction |  | 0..* | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
condition |  | 0..* | BackboneElement | Whether or not the action is applicable
kind |  | 1..1 | code | applicability | start | stop Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language |  | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath
relatedAction |  | 0..* | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
action:reportCancerData |  | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S C | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting Constraints: pdf-0
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
extension:asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
extension:contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
extension:jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
extension:contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
extension:expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the plan definition
version | S Σ | 1..1 | string | Business version of the PlanDefinition
name | S Σ C | 1..1 | string | Name for this PlanDefinition (computer friendly)
title | S Σ | 1..1 | string | Title for this PlanDefinition
subtitle |  | 0..1 | string | Subordinate title of the plan definition
type | S Σ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition
display |  | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage
subject[x] | S | 0..1 |  | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 1..1 | dateTime | Date the PlanDefinition was last changed
publisher | S Σ | 1..1 | string | Name of the agency that published this PlanDefinition
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the plan definition
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this plan definition is defined
usage |  | 0..1 | string | Describes the clinical usage of the plan
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
approvalDate |  | 0..1 | date | When the plan definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the plan definition was last reviewed
effectivePeriod | S Σ | 0..1 | Period | When the PlanDefinition is valid
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect
end | Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic |  | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
relatedArtifact |  | 0..* | RelatedArtifact | Additional documentation, citations
library | S | 0..* | canonical(Library) | Logic used by the plan definition
goal |  | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
category |  | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
priority |  | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
start |  | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses |  | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the goal
target |  | 0..* | BackboneElement | Target outcome for the goal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
measure |  | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x] |  | 0..1 |  | The target value to be achieved
detailQuantity |  |  | Quantity |
detailRange |  |  | Range |
detailCodeableConcept |  |  | CodeableConcept |
due |  | 0..1 | Duration | Reach goal within
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Closed by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:checkReportable | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | Σ | 0..1 | string | Natural language description of the condition
name | Σ | 0..1 | id | Short name assigned to expression for reuse
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
expression | Σ | 0..1 | string | Expression in specified language
reference | Σ | 0..1 | uri | Where the expression is found
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | Σ | 0..1 | string | Natural language description of the condition
name | Σ | 0..1 | id | Short name assigned to expression for reuse
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
expression | Σ | 0..1 | string | Expression in specified language
reference | Σ | 0..1 | uri | Where the expression is found
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:reportCancerData | S | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📦4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📦4.0.1 | FHIR Std.
PlanDefinition.topic | Base | example | DefinitionTopic | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal category | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal priority | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal start event | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:encounterClose.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:checkReportable.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:reportCancerData.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | 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 | error | PlanDefinition | 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 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter, PlanDefinition.action:encounterClose.input.codeFilter, PlanDefinition.action:encounterClose.output.codeFilter, PlanDefinition.action:checkReportable.input.codeFilter, PlanDefinition.action:checkReportable.output.codeFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter, PlanDefinition.action:reportCancerData.input.codeFilter, PlanDefinition.action:reportCancerData.output.codeFilter | Either a path or a searchParam must be provided, but not both | `path.exists() xor searchParam.exists()`
drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter, PlanDefinition.action:encounterClose.input.dateFilter, PlanDefinition.action:encounterClose.output.dateFilter, PlanDefinition.action:checkReportable.input.dateFilter, PlanDefinition.action:checkReportable.output.dateFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter, PlanDefinition.action:reportCancerData.input.dateFilter, PlanDefinition.action:reportCancerData.output.dateFilter | Either a path or a searchParam must be provided, but not both | `path.exists() xor searchParam.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | 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}')`

This structure is derived from USPublicHealthPlanDefinition

Summary

Mandatory: 9 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 28 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of PlanDefinition.action (ordered)
- The element 1 is sliced based on the value of PlanDefinition.action.action
- The element 1 is sliced based on the value of PlanDefinition.action.action (ordered)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S C | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting Constraints: pdf-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
extension:asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
extension:contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
extension:jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
extension:contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
extension:expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the plan definition
version | S Σ | 1..1 | string | Business version of the PlanDefinition
name | S Σ C | 1..1 | string | Name for this PlanDefinition (computer friendly)
title | S Σ | 1..1 | string | Title for this PlanDefinition
type | S Σ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition
display |  | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage
subject[x] | S | 0..1 |  | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 1..1 | dateTime | Date the PlanDefinition was last changed
publisher | S Σ | 1..1 | string | Name of the agency that published this PlanDefinition
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the plan definition
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
effectivePeriod | S Σ | 0..1 | Period | When the PlanDefinition is valid
start | Σ C | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect
library | S | 0..* | canonical(Library) | Logic used by the plan definition
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Brief description of the action
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Closed by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
timing[x] | S | 0..1 | Duration | When the action should take place
action:checkReportable | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
action:reportCancerData | S | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
Slices for extension |  |  |  | Content/Rules for all slices
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
output | S | 0..* | DataRequirement | Output data definition
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📦4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:encounterClose.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:checkReportable.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:reportCancerData.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | 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 | error | PlanDefinition | 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 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | 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}')`

Differential View

This structure is derived from USPublicHealthPlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
input |  | 0..* | DataRequirement | Input data requirements
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
code | S | 1..1 | CodeableConcept | Code for the "start" action. Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type |  | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event
name |  | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
action:checkReportable |  | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
description |  | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
kind |  | 1..1 | code | applicability | start | stop Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language |  | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
relatedAction |  | 0..* | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
condition |  | 0..* | BackboneElement | Whether or not the action is applicable
kind |  | 1..1 | code | applicability | start | stop Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
language |  | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath
relatedAction |  | 0..* | BackboneElement | Relationship to another action
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start
offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
action:reportCancerData |  | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | S C | 1..1 | USPublicHealthPlanDefinition | ccrr-Central Cancer Registry Reporting Constraints: pdf-0
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
extension:asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
extension:contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
extension:jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
extension:contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
extension:expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the plan definition
version | S Σ | 1..1 | string | Business version of the PlanDefinition
name | S Σ C | 1..1 | string | Name for this PlanDefinition (computer friendly)
title | S Σ | 1..1 | string | Title for this PlanDefinition
subtitle |  | 0..1 | string | Subordinate title of the plan definition
type | S Σ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition
display |  | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage
subject[x] | S | 0..1 |  | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 1..1 | dateTime | Date the PlanDefinition was last changed
publisher | S Σ | 1..1 | string | Name of the agency that published this PlanDefinition
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the plan definition
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this plan definition is defined
usage |  | 0..1 | string | Describes the clinical usage of the plan
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
approvalDate |  | 0..1 | date | When the plan definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the plan definition was last reviewed
effectivePeriod | S Σ | 0..1 | Period | When the PlanDefinition is valid
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect
end | Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic |  | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
relatedArtifact |  | 0..* | RelatedArtifact | Additional documentation, citations
library | S | 0..* | canonical(Library) | Logic used by the plan definition
goal |  | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
category |  | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
priority |  | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
start |  | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses |  | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the goal
target |  | 0..* | BackboneElement | Target outcome for the goal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
measure |  | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x] |  | 0..1 |  | The target value to be achieved
detailQuantity |  |  | Quantity |
detailRange |  |  | Range |
detailCodeableConcept |  |  | CodeableConcept |
due |  | 0..1 | Duration | Reach goal within
Slices for action | S | 2..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:encounterClose | S | 0..1 | BackboneElement | Encounter Close Action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-close event
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-close event
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered.
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-close
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 1..1 | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Closed by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:checkReportable | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Check if the Encounter qualifies as check-reportable Fixed Value: This action represents the check for suspected reportability of the cancer data.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
Slices for action |  | 2..* | BackboneElement | A sub-action Slice: Unordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | Σ | 0..1 | string | Natural language description of the condition
name | Σ | 0..1 | id | Short name assigned to expression for reuse
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
expression | Σ | 0..1 | string | Expression in specified language
reference | Σ | 0..1 | uri | Where the expression is found
input | S | 0..* | DataRequirement | Input data requirements
id | S | 1..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: report-cancer-data
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:shouldContinueReporting | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: should-continue-reporting
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability
expression | S | 1..1 | Expression | Boolean-valued expression
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | Σ | 0..1 | string | Natural language description of the condition
name | Σ | 0..1 | id | Short name assigned to expression for reuse
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Fixed Value: text/fhirpath
expression | Σ | 0..1 | string | Expression in specified language
reference | Σ | 0..1 | uri | Where the expression is found
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to Fixed Value: check-reportable
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration |  | 0..1 | Duration | Time offset for the relationship Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:reportCancerData | S | 0..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints.
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: report-cancer-data
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger | S | 0..* | TriggerDefinition | When the action should be triggered
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
type | S Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name | Σ | 0..1 | string | Name or URI that identifies the event
timing[x] | Σ | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression)
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression | S | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
output | S | 0..* | DataRequirement | Output data definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data
subject[x] | Σ | 0..1 |  | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module
codeFilter | Σ C | 0..* | Element | What codes are expected Constraints: drq-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A code-valued attribute to filter on
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter
code | Σ | 0..* | Coding | What code is expected
dateFilter | Σ C | 0..* | Element | What dates/date ranges are expected Constraints: drq-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 0..1 | string | A date-valued attribute to filter on
searchParam | Σ | 0..1 | string | A date valued parameter to search on
value[x] | Σ | 0..1 |  | The value of the filter, as a Period, DateTime, or Duration value
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
valueDuration |  |  | Duration |
limit | Σ | 0..1 | positiveInt | Number of results
sort | Σ | 0..* | Element | Order of the results
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
path | Σ | 1..1 | string | The name of the attribute to perform the sort
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action is this related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
Slices for offset[x] |  | 0..1 |  | Time offset for the relationship Slice: Unordered, Open by type:$this
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship
timing[x] | S | 0..1 | Duration | When the action should take place
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
Slices for action | S | 3..* | BackboneElement | A sub-action Slice: Ordered, Open by value:id
action:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:createCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:validateCancerReport | S | 1..1 | BackboneElement | A sub-action
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the cancer report.
textEquivalent |  | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
action:routeAndSendCancerReport | S | 1..1 | BackboneElement | Route and send cancer report
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-cancer-report
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the cancer report.
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send cancer report
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
trigger |  | 0..* | TriggerDefinition | When the action should be triggered
condition | S | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | S | 0..* | DataRequirement | Input data requirements
output | S | 0..* | DataRequirement | Output data definition
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId |  | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] |  | 0..1 |  | Description of the activity to be performed
definitionCanonical |  |  | canonical(ActivityDefinition | PlanDefinition | Questionnaire) |
definitionUri |  |  | uri |
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📦4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📦4.0.1 | FHIR Std.
PlanDefinition.topic | Base | example | DefinitionTopic | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal category | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal priority | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal start event | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:encounterClose.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:encounterClose.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:checkReportable.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:isEncounterReportable.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​condition.expression.​language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:checkReportable.​action:shouldContinueReporting.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​code | Base | extensible | US Public Health VaueSet - PlanDefinition Action | 📦1.0.0 | US Public Health Profiles Library v1.0
PlanDefinition.action:reportCancerData.​subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.subject[x] | Base | extensible | Subject type | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​participant.role | Base | example | Action participant role | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​type | Base | extensible | ActionType | 📦4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:createCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:validateCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:reportCancerData.​action:routeAndSendCancerReport.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | 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 | error | PlanDefinition | 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 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter, PlanDefinition.action:encounterClose.input.codeFilter, PlanDefinition.action:encounterClose.output.codeFilter, PlanDefinition.action:checkReportable.input.codeFilter, PlanDefinition.action:checkReportable.output.codeFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter, PlanDefinition.action:reportCancerData.input.codeFilter, PlanDefinition.action:reportCancerData.output.codeFilter | Either a path or a searchParam must be provided, but not both | `path.exists() xor searchParam.exists()`
drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter, PlanDefinition.action:encounterClose.input.dateFilter, PlanDefinition.action:encounterClose.output.dateFilter, PlanDefinition.action:checkReportable.input.dateFilter, PlanDefinition.action:checkReportable.output.dateFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter, PlanDefinition.action:reportCancerData.input.dateFilter, PlanDefinition.action:reportCancerData.output.dateFilter | Either a path or a searchParam must be provided, but not both | `path.exists() xor searchParam.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | 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}')`

This structure is derived from USPublicHealthPlanDefinition

Summary

Mandatory: 9 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 28 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of PlanDefinition.action (ordered)
- The element 1 is sliced based on the value of PlanDefinition.action.action
- The element 1 is sliced based on the value of PlanDefinition.action.action (ordered)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron