This page is part of the electronic Case Reporting (eCR) (v2.1.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in it's permanent location. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition | Version: 2.1.1 | |||
Active as of 2023-12-14 | Computable Name: ERSDPlanDefinition |
This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by an eRSD specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. The final determination of reportability is made by the Public Health Agency or Agencies appropriate for the event, and may be performed by a combination of decisions occurring at various points during the processing of an eICR, as explained in the Reportability Response profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthPlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable |
Slices for action | S | 5..* | 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 PlanDefinition Action (extensible): The set of actions that can be used to create plan definition |
input | 0..* | DataRequirement | Input data requirements | |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension |
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" |
relatedAction | ||||
offsetDuration | S | 0..1 | Duration | Time offset for the relationship |
action:encounterStart | S | 1..1 | BackboneElement | Encounter start code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow |
description | S | 1..1 | string | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. |
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: check-suspected-disorder | |
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 1 hour before next action.: {"value":1,"unit":"h"} | |
action:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder |
description | S | 1..1 | string | Description of the check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. |
code | S | 1..1 | CodeableConcept | Code for the "check-suspected-disorder" 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 2..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder |
code | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
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 | |
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: create-eicr | |
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-check-reportable |
code | 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/ecr/CodeSystem/us-ph-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 hours before next action.: {"value":6,"unit":"h"} | |
action:checkReportable | 1..1 | BackboneElement | Check the encounter for reportability | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable |
description | 0..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | |
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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 3..* | A sub-action Slice: Unordered, Open by value:id | ||
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..* | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
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 | |
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: create-eicr | |
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr |
code | 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/ecr/CodeSystem/us-ph-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: create-eicr | |
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress |
code | 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/ecr/CodeSystem/us-ph-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 hours before next action.: {"value":6,"unit":"h"} | |
action:createEicr | 1..1 | BackboneElement | Create the eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the eICR. It subsequently calls validate. | |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: validate-eicr | |
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:validateEicr | 1..1 | BackboneElement | Validate the eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the eICR. It subsequently calls route-and-send. | |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: route-and-send-eicr | |
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:routeAndSendEicr | 1..1 | BackboneElement | Route and send eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr |
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the eICR. |
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 eICR |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |
action:encounterModified | S | 1..1 | BackboneElement | Encounter modified code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified |
description | S | 1..1 | string | Description of the "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event |
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified event |
code | S | 1..1 | CodeableConcept | Code for the "encounter-modified" 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | |
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 | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: create-eicr | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) |
Id | Grade | Path(s) | Details | Requirements |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
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 | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
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 | |||||
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 | 5..* | 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 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 | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" | ||||
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, Closed 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:encounterStart | S | 1..1 | BackboneElement | Encounter start code | ||||
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 | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start event | ||||
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | ||||
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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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-suspected-disorder | ||||
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 1 hour before next action.: {"value":1,"unit":"h"} | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. | ||||
code | S | 1..1 | CodeableConcept | Code for the "check-suspected-disorder" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |||||
condition | 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.
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. | ||||
relatedAction | 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: create-eicr | |||||
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-check-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
action:checkReportable | S | 1..1 | BackboneElement | Check the encounter for reportability | ||||
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 | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | ||||
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | 3..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
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..* | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |||||
condition | 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.
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. | ||||
relatedAction | 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: create-eicr | |||||
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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: create-eicr | |||||
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
action:createEicr | S | 1..1 | BackboneElement | Create the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr | ||||
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 of the eICR. It subsequently calls validate. | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: validate-eicr | ||||
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, 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:validateEicr | S | 1..1 | BackboneElement | Validate the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr | ||||
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 validation of the eICR. It subsequently calls route-and-send. | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: route-and-send-eicr | ||||
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, 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:routeAndSendEicr | S | 1..1 | BackboneElement | Route and send eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr | ||||
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 eICR. | ||||
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 eICR | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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:encounterModified | S | 1..1 | BackboneElement | Encounter modified code | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified event | ||||
code | S | 1..1 | CodeableConcept | Code for the "encounter-modified" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | ||||
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. 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.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: create-eicr | ||||
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, 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:encounterStart.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterStart.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterStart.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:encounterStart.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkSuspectedDisorder.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkSuspectedDisorder.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkReportable.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkReportable.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createEicr.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:createEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateEicr.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:validateEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:routeAndSendEicr.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:routeAndSendEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:routeAndSendEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:routeAndSendEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:encounterModified.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterModified.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterModified.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:encounterModified.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:encounterModified.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.relatedAction.relationship | required | Fixed Value: before-start |
Id | Grade | Path(s) | Details | Requirements |
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()) | |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) | |
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}') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
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 | 5..* | 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 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" | ||||
value[x] | 0..1 | string | Value of extension | |||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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, Closed 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:encounterStart | S | 1..1 | BackboneElement | Encounter start code | ||||
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 | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start 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 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/ecr/CodeSystem/us-ph-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 | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
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 | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | ||||
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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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-suspected-disorder | ||||
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 1 hour before next action.: {"value":1,"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:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder | ||||
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 check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. | ||||
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 for the "check-suspected-disorder" action. Binding: US Public Health 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/ecr/CodeSystem/us-ph-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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-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 | 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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
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:checkReportable | S | 1..1 | BackboneElement | Check the encounter for reportability | ||||
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 | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | ||||
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 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/ecr/CodeSystem/us-ph-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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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 | 3..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
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:createEicr | S | 1..1 | BackboneElement | Create the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr | ||||
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 of the eICR. It subsequently calls validate. | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: validate-eicr | ||||
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, 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:validateEicr | S | 1..1 | BackboneElement | Validate the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr | ||||
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 validation of the eICR. It subsequently calls route-and-send. | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: route-and-send-eicr | ||||
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, 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:routeAndSendEicr | S | 1..1 | BackboneElement | Route and send eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr | ||||
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 eICR. | ||||
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 eICR | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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:encounterModified | S | 1..1 | BackboneElement | Encounter modified code | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified | ||||
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 "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified 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 "encounter-modified" action. Binding: US Public Health 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/ecr/CodeSystem/us-ph-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 | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
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 | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | ||||
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. 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.
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 | 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 | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: create-eicr | ||||
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, 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.language | preferred | CommonLanguages
| ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.topic | example | DefinitionTopic | ||||
PlanDefinition.goal.category | example | GoalCategory | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
PlanDefinition.goal.priority | preferred | GoalPriority | ||||
PlanDefinition.goal.start | example | GoalStartEvent | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
PlanDefinition.action.priority | required | RequestPriority | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) | ||||
PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action.type | extensible | ActionType | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:encounterStart.priority | required | RequestPriority | ||||
PlanDefinition.action:encounterStart.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterStart.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterStart.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:encounterStart.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterStart.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterStart.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:encounterStart.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:encounterStart.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:encounterStart.type | extensible | ActionType | ||||
PlanDefinition.action:encounterStart.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:encounterStart.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:encounterStart.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:encounterStart.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:encounterStart.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkSuspectedDisorder.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkSuspectedDisorder.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkSuspectedDisorder.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkReportable.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:createEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:createEicr.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:createEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:createEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:createEicr.type | extensible | ActionType | ||||
PlanDefinition.action:createEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:createEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:createEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:createEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:createEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:validateEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:validateEicr.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:validateEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:validateEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:validateEicr.type | extensible | ActionType | ||||
PlanDefinition.action:validateEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:validateEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:validateEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:validateEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:validateEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:routeAndSendEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:routeAndSendEicr.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:routeAndSendEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:routeAndSendEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:routeAndSendEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:routeAndSendEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:routeAndSendEicr.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:routeAndSendEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:routeAndSendEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:routeAndSendEicr.type | extensible | ActionType | ||||
PlanDefinition.action:routeAndSendEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:routeAndSendEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:routeAndSendEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:routeAndSendEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:routeAndSendEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:encounterModified.priority | required | RequestPriority | ||||
PlanDefinition.action:encounterModified.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterModified.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterModified.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:encounterModified.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:encounterModified.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterModified.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterModified.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:encounterModified.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:encounterModified.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:encounterModified.type | extensible | ActionType | ||||
PlanDefinition.action:encounterModified.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:encounterModified.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:encounterModified.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:encounterModified.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:encounterModified.cardinalityBehavior | required | ActionCardinalityBehavior |
Id | Grade | Path(s) | Details | Requirements |
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:encounterStart.input.codeFilter, PlanDefinition.action:encounterStart.output.codeFilter, PlanDefinition.action:checkSuspectedDisorder.input.codeFilter, PlanDefinition.action:checkSuspectedDisorder.output.codeFilter, PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.codeFilter, PlanDefinition.action:checkReportable.input.codeFilter, PlanDefinition.action:checkReportable.output.codeFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter, PlanDefinition.action:createEicr.input.codeFilter, PlanDefinition.action:createEicr.output.codeFilter, PlanDefinition.action:validateEicr.input.codeFilter, PlanDefinition.action:validateEicr.output.codeFilter, PlanDefinition.action:routeAndSendEicr.input.codeFilter, PlanDefinition.action:routeAndSendEicr.output.codeFilter, PlanDefinition.action:encounterModified.input.codeFilter, PlanDefinition.action:encounterModified.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:encounterStart.input.dateFilter, PlanDefinition.action:encounterStart.output.dateFilter, PlanDefinition.action:checkSuspectedDisorder.input.dateFilter, PlanDefinition.action:checkSuspectedDisorder.output.dateFilter, PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.dateFilter, PlanDefinition.action:checkReportable.input.dateFilter, PlanDefinition.action:checkReportable.output.dateFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter, PlanDefinition.action:createEicr.input.dateFilter, PlanDefinition.action:createEicr.output.dateFilter, PlanDefinition.action:validateEicr.input.dateFilter, PlanDefinition.action:validateEicr.output.dateFilter, PlanDefinition.action:routeAndSendEicr.input.dateFilter, PlanDefinition.action:routeAndSendEicr.output.dateFilter, PlanDefinition.action:encounterModified.input.dateFilter, PlanDefinition.action:encounterModified.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()) | |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) | |
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: 46 elements (9 nested mandatory elements)
Must-Support: 56 elements
Fixed Value: 57 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USPublicHealthPlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable |
Slices for action | S | 5..* | 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 PlanDefinition Action (extensible): The set of actions that can be used to create plan definition |
input | 0..* | DataRequirement | Input data requirements | |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension |
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" |
relatedAction | ||||
offsetDuration | S | 0..1 | Duration | Time offset for the relationship |
action:encounterStart | S | 1..1 | BackboneElement | Encounter start code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow |
description | S | 1..1 | string | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. |
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: check-suspected-disorder | |
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 1 hour before next action.: {"value":1,"unit":"h"} | |
action:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder |
description | S | 1..1 | string | Description of the check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. |
code | S | 1..1 | CodeableConcept | Code for the "check-suspected-disorder" 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 2..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder |
code | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
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 | |
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: create-eicr | |
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-check-reportable |
code | 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/ecr/CodeSystem/us-ph-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 hours before next action.: {"value":6,"unit":"h"} | |
action:checkReportable | 1..1 | BackboneElement | Check the encounter for reportability | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable |
description | 0..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | |
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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 3..* | A sub-action Slice: Unordered, Open by value:id | ||
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..* | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
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 | |
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: create-eicr | |
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr |
code | 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/ecr/CodeSystem/us-ph-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: create-eicr | |
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress |
code | 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/ecr/CodeSystem/us-ph-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 hours before next action.: {"value":6,"unit":"h"} | |
action:createEicr | 1..1 | BackboneElement | Create the eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation of the eICR. It subsequently calls validate. | |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: validate-eicr | |
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:validateEicr | 1..1 | BackboneElement | Validate the eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the eICR. It subsequently calls route-and-send. | |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: route-and-send-eicr | |
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:routeAndSendEicr | 1..1 | BackboneElement | Route and send eICR | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr |
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the eICR. |
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 eICR |
code | 0..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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |
action:encounterModified | S | 1..1 | BackboneElement | Encounter modified code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified |
description | S | 1..1 | string | Description of the "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event |
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified event |
code | S | 1..1 | CodeableConcept | Code for the "encounter-modified" 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/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | |
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 | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: create-eicr | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) |
Id | Grade | Path(s) | Details | Requirements |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
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 | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
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 | |||||
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 | 5..* | 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 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 | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" | ||||
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, Closed 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:encounterStart | S | 1..1 | BackboneElement | Encounter start code | ||||
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 | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start event | ||||
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | ||||
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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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-suspected-disorder | ||||
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 1 hour before next action.: {"value":1,"unit":"h"} | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. | ||||
code | S | 1..1 | CodeableConcept | Code for the "check-suspected-disorder" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |||||
condition | 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.
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. | ||||
relatedAction | 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: create-eicr | |||||
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-check-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
action:checkReportable | S | 1..1 | BackboneElement | Check the encounter for reportability | ||||
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 | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | ||||
code | S | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | 3..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
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..* | 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |||||
condition | 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.
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. | ||||
relatedAction | 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: create-eicr | |||||
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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: create-eicr | |||||
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 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/ecr/CodeSystem/us-ph-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 | |||||
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.
Fixed Value: text/fhirpath | ||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
action:createEicr | S | 1..1 | BackboneElement | Create the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr | ||||
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 of the eICR. It subsequently calls validate. | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: validate-eicr | ||||
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, 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:validateEicr | S | 1..1 | BackboneElement | Validate the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr | ||||
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 validation of the eICR. It subsequently calls route-and-send. | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: route-and-send-eicr | ||||
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, 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:routeAndSendEicr | S | 1..1 | BackboneElement | Route and send eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr | ||||
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 eICR. | ||||
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 eICR | ||||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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:encounterModified | S | 1..1 | BackboneElement | Encounter modified code | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified event | ||||
code | S | 1..1 | CodeableConcept | Code for the "encounter-modified" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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/ecr/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | ||||
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. 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.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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: create-eicr | ||||
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, 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:encounterStart.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterStart.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterStart.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:encounterStart.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkSuspectedDisorder.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkSuspectedDisorder.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkReportable.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkReportable.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createEicr.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:createEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateEicr.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:validateEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:routeAndSendEicr.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:routeAndSendEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:routeAndSendEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:routeAndSendEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:encounterModified.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterModified.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterModified.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:encounterModified.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:encounterModified.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.relatedAction.relationship | required | Fixed Value: before-start |
Id | Grade | Path(s) | Details | Requirements |
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()) | |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) | |
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}') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
receiverAddress | S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
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 | 5..* | 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 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
us-ph-fhirquerypattern-extension | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" | ||||
value[x] | 0..1 | string | Value of extension | |||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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, Closed 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:encounterStart | S | 1..1 | BackboneElement | Encounter start code | ||||
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 | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start 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 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/ecr/CodeSystem/us-ph-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 | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
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 | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-start | ||||
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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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-suspected-disorder | ||||
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 1 hour before next action.: {"value":1,"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:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder | ||||
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 check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. | ||||
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 for the "check-suspected-disorder" action. Binding: US Public Health 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/ecr/CodeSystem/us-ph-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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-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 | 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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
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:checkReportable | S | 1..1 | BackboneElement | Check the encounter for reportability | ||||
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 | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | ||||
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 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/ecr/CodeSystem/us-ph-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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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 | 3..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | |||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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: create-eicr | |||||
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:encounterInProgress | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress | ||||
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..* | 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/ecr/CodeSystem/us-ph-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 | 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.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 hours before next action.: {"value":6,"unit":"h"} | |||||
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:createEicr | S | 1..1 | BackboneElement | Create the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr | ||||
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 of the eICR. It subsequently calls validate. | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: validate-eicr | ||||
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, 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:validateEicr | S | 1..1 | BackboneElement | Validate the eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr | ||||
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 validation of the eICR. It subsequently calls route-and-send. | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: route-and-send-eicr | ||||
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, 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:routeAndSendEicr | S | 1..1 | BackboneElement | Route and send eICR | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: route-and-send-eicr | ||||
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 eICR. | ||||
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 eICR | ||||
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 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/ecr/CodeSystem/us-ph-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 | 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 | |||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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 | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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:encounterModified | S | 1..1 | BackboneElement | Encounter modified code | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: encounter-modified | ||||
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 "encounter-modified" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the "encounter-modified" action. Fixed Value: Start the reporting workflow in response to an encounter-modified 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 "encounter-modified" action. Binding: US Public Health 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/ecr/CodeSystem/us-ph-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 | SC | 1..* | TriggerDefinition | When the "encounter-modified" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element | ||||
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 | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health 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-modified | ||||
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. 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.
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 | 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 | |||||
relatedData | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
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 | ||||
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 | ||||
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 | ||||
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 | ||||
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: create-eicr | ||||
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, 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.language | preferred | CommonLanguages
| ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.topic | example | DefinitionTopic | ||||
PlanDefinition.goal.category | example | GoalCategory | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
PlanDefinition.goal.priority | preferred | GoalPriority | ||||
PlanDefinition.goal.start | example | GoalStartEvent | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
PlanDefinition.action.priority | required | RequestPriority | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes) | ||||
PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action.type | extensible | ActionType | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:encounterStart.priority | required | RequestPriority | ||||
PlanDefinition.action:encounterStart.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterStart.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterStart.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:encounterStart.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterStart.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterStart.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterStart.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterStart.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:encounterStart.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:encounterStart.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:encounterStart.type | extensible | ActionType | ||||
PlanDefinition.action:encounterStart.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:encounterStart.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:encounterStart.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:encounterStart.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:encounterStart.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkSuspectedDisorder.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkSuspectedDisorder.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkSuspectedDisorder.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkSuspectedDisorder.action:continueCheckReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:checkReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:checkReportable.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:checkReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:checkReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:isEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:checkUpdateEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.priority | required | RequestPriority | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.type | extensible | ActionType | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:checkReportable.action:encounterInProgress.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:createEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:createEicr.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:createEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:createEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:createEicr.type | extensible | ActionType | ||||
PlanDefinition.action:createEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:createEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:createEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:createEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:createEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:validateEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:validateEicr.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:validateEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateEicr.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:validateEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:validateEicr.type | extensible | ActionType | ||||
PlanDefinition.action:validateEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:validateEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:validateEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:validateEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:validateEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:routeAndSendEicr.priority | required | RequestPriority | ||||
PlanDefinition.action:routeAndSendEicr.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:routeAndSendEicr.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:routeAndSendEicr.condition.kind | required | ActionConditionKind | ||||
PlanDefinition.action:routeAndSendEicr.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:routeAndSendEicr.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:routeAndSendEicr.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:routeAndSendEicr.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:routeAndSendEicr.relatedAction.relationship | required | ActionRelationshipType | ||||
PlanDefinition.action:routeAndSendEicr.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:routeAndSendEicr.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:routeAndSendEicr.type | extensible | ActionType | ||||
PlanDefinition.action:routeAndSendEicr.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:routeAndSendEicr.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:routeAndSendEicr.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:routeAndSendEicr.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:routeAndSendEicr.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:encounterModified.priority | required | RequestPriority | ||||
PlanDefinition.action:encounterModified.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:encounterModified.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:encounterModified.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:encounterModified.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:encounterModified.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterModified.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:encounterModified.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:encounterModified.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:encounterModified.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:encounterModified.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:encounterModified.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:encounterModified.type | extensible | ActionType | ||||
PlanDefinition.action:encounterModified.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:encounterModified.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:encounterModified.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:encounterModified.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:encounterModified.cardinalityBehavior | required | ActionCardinalityBehavior |
Id | Grade | Path(s) | Details | Requirements |
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:encounterStart.input.codeFilter, PlanDefinition.action:encounterStart.output.codeFilter, PlanDefinition.action:checkSuspectedDisorder.input.codeFilter, PlanDefinition.action:checkSuspectedDisorder.output.codeFilter, PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.codeFilter, PlanDefinition.action:checkReportable.input.codeFilter, PlanDefinition.action:checkReportable.output.codeFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter, PlanDefinition.action:createEicr.input.codeFilter, PlanDefinition.action:createEicr.output.codeFilter, PlanDefinition.action:validateEicr.input.codeFilter, PlanDefinition.action:validateEicr.output.codeFilter, PlanDefinition.action:routeAndSendEicr.input.codeFilter, PlanDefinition.action:routeAndSendEicr.output.codeFilter, PlanDefinition.action:encounterModified.input.codeFilter, PlanDefinition.action:encounterModified.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:encounterStart.input.dateFilter, PlanDefinition.action:encounterStart.output.dateFilter, PlanDefinition.action:checkSuspectedDisorder.input.dateFilter, PlanDefinition.action:checkSuspectedDisorder.output.dateFilter, PlanDefinition.action:checkSuspectedDisorder.action:isEncounterSuspectedDisorder.input.dateFilter, PlanDefinition.action:checkReportable.input.dateFilter, PlanDefinition.action:checkReportable.output.dateFilter, PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter, PlanDefinition.action:createEicr.input.dateFilter, PlanDefinition.action:createEicr.output.dateFilter, PlanDefinition.action:validateEicr.input.dateFilter, PlanDefinition.action:validateEicr.output.dateFilter, PlanDefinition.action:routeAndSendEicr.input.dateFilter, PlanDefinition.action:routeAndSendEicr.output.dateFilter, PlanDefinition.action:encounterModified.input.dateFilter, PlanDefinition.action:encounterModified.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()) | |
epd-1 | error | PlanDefinition.action:encounterStart.trigger, PlanDefinition.action:encounterModified.trigger | The code value of the namedEventType SHALL be the same as the name element : name.supersetOf(extension('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code) | |
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: 46 elements (9 nested mandatory elements)
Must-Support: 56 elements
Fixed Value: 57 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron