This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
SD.32 StructureDefinition-ersd-plandefinition
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 profile defines three timing-related parameters for initiating case reports from Electronic Health Records (the standard does not specify the hour value for the delay of the send - public health operations will determine the specific value appropriate for implementation) the standard conveys the parameters to clinical care but it does not require their implementation.
- Delay initial eICR construction (for example 1 hour) - the time after start of the encounter when the trigger events would not immediately cause an eICR to be composed and sent. (This delay is intended to allow adequate data to be recorded in the EHR, but is not so long as to delay reporting in critical circumstances.) If there is a trigger and the encounter is closed before the specified delay value (for example the encounter is closed in 30 minutes when the specified delay value is 1 hour) the eICR should be created and sent.
- eICR periodic update (for example 24 hours) - the time after an initial eICR creation to send new eICRs as updates during long encounters. (These updates should only be produced until the end of the encounter).
- eICR encounter close-out (for example 24 hours or 0 hours for no delay) - the time after the end of an encounter for a final eICR to be sent when there has been one or more trigger events in the encounter. (The close-out eICR is intended to provide the full data available at the end of an encounter.)
SD.32.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition
Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.
This profile builds on PlanDefinition
Summary
Mandatory: 66 elements (3 nested mandatory elements)
Must-Support: 69 elements
Fixed Value: 46 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element PlanDefinition.action is sliced based on the value of value:id (ordered)
- The element PlanDefinition.action.condition is sliced based on the value of value:kind
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 0..* | PlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
version | S | 1..1 | string | Business version of the eRSD |
name | S | 1..1 | string | Name for this eRSD (computer friendly) |
title | S | 1..1 | string | Title for this eRSD |
type | S | 0..1 | CodeableConcept | Type of this eRSD |
date | S | 1..1 | dateTime | Date the eRSD was published |
publisher | 0..1 | string | Name of the agency that published this eRSD | |
effectivePeriod | S | 0..1 | Period | When the eRSD is expected to be used |
start | 1..1 | dateTime | The start of the time period when this eRSD goes in effect | |
library | S | 0..* | canonical(Library) | |
action | S | 1..* | (Slice Definition) | Slice: Ordered, Open by value:id |
action:sliceMatchTrigger | S | 1..1 | BackboneElement | Match trigger code |
id | S | 1..1 | string | Fixed Value: match-trigger |
description | S | 1..1 | string | Description of the "match-trigger" action. Fixed Value: This action represents the matching of a trigger code to one of the values in the eRSD value sets. |
textEquivalent | S | 1..1 | string | Text equivalent of the "match-trigger" action. Fixed Value: Match of a code to one of the values in the eRSD value sets. |
trigger | S | 1..* | TriggerDefinition | When the "match-trigger" action should be triggered. |
type | 1..1 | code | Fixed Value: data-changed | |
data | S | 1..* | DataRequirement | A triggering value set. |
type | 1..1 | code | The type of trigger data. | |
codeFilter | S | 1..1 | Element | Match based on code. |
path | S | 1..1 | string | Path to the code to match |
valueSet | 1..1 | canonical(eRSD Value Set) | eRSD value set containing trigger codes. | |
action:sliceCreateEICR | S | 1..1 | BackboneElement | Create eICR |
id | S | 1..1 | string | Fixed Value: create-eicr |
description | S | 1..1 | string | Description of the "create-eicr" action. Fixed Value: This action represents the initial creation of the eICR. |
textEquivalent | S | 1..1 | string | Text equivalent of the "create-ecir" action. Fixed Value: eICR construction delay (offsetDuration.value = x hours) - time after trigger event before an eICR should be created. |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: match-trigger | |
relationship | 1..1 | code | Fixed Value: after | |
offset[x] | 0..1 | Duration | Example for initial delay duration of 1 hour: {"value":1,"unit":"h"} | |
value | S | 1..1 | decimal | [x - value] |
unit | S | 1..1 | string | Fixed Value: h |
action:slicePeriodicUpdateEICR | S | 1..1 | BackboneElement | Periodic Update of eICR |
id | 1..1 | string | Fixed Value: periodic-update-eicr | |
description | S | 1..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the periodic update of the eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: eICR periodic update (repeat.frequency = y hours) - the time after an initial eICR creation to send a new eICR as an update during long encounters. |
trigger | S | 1..1 | TriggerDefinition | Trigger every y hours after first eICR creation. |
type | 1..1 | code | Fixed Value: periodic | |
timing[x] | S | 1..1 | Timing | Example for periodic update: {"repeat":{"frequency":1,"period":24,"periodUnit":"h"}} |
repeat | S | 1..1 | Element | Repeat update of eICR every [y - period] hours. |
frequency | S | 1..1 | positiveInt | Fixed Value: 1 |
period | S | 1..1 | decimal | [y - period] |
periodUnit | S | 1..1 | code | Unit - hours Fixed Value: h |
condition | S | 1..* | (Slice Definition) | Slice: Unordered, Open by value:kind |
condition:sliceStartCondition | S | 1..1 | BackboneElement | |
kind | 1..1 | code | Fixed Value: start | |
expression | S | 1..1 | Expression | |
description | 0..1 | string | Fixed Value: Encounter is active. | |
language | 1..1 | code | Example CQL: text/cql | |
expression | S | 1..1 | string | Encounter started. Example CQL: encounter.period.start != null and encounter.period.end = null |
condition:sliceStopCondition | S | 1..1 | BackboneElement | |
kind | 1..1 | code | Fixed Value: stop | |
expression | S | 1..1 | Expression | |
description | 0..1 | string | Fixed Value: Encounter is closed. | |
language | 1..1 | code | Example CQL: text/cql | |
expression | S | 1..1 | string | Encounter ended. Example CQL: encounter.period.end != null |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: create-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
action:sliceCloseOutEICR | S | 1..1 | BackboneElement | Close Out eICR action |
id | 1..1 | string | Fixed Value: close-out-eicr | |
description | S | 1..1 | string | Description of the "close-out-eicr" action. Fixed Value: This action represents the close out of an eICR encounter. |
textEquivalent | S | 1..1 | string | Fixed Value: eICR encounter close out (timingTiming.repeat.duration = z hours) - the time after the end of the encounter to create the final eICR when there have been one or more trigger events. |
trigger | S | 1..1 | TriggerDefinition | |
type | 1..1 | code | Fixed Value: data-added | |
data | S | 1..1 | DataRequirement | Trigger when Encounter.period.end is added. |
type | 1..1 | code | Fixed Value: Encounter | |
profile | S | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter |
dateFilter | S | 1..1 | Element | |
path | S | 1..1 | string | Fixed Value: period.end |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: create-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
timing[x] | S | 1..1 | Timing | Example for close out duration of 24 hours after end of encounter: {"repeat":{"count":1,"duration":24,"durationUnit":"h","frequency":1}} |
repeat | S | 1..1 | Element | Close out eICR [z] hours after end of encounter. |
count | S | 1..1 | positiveInt | Fixed Value: 1 |
duration | S | 1..1 | decimal | [z - duration] |
durationUnit | S | 1..1 | code | Fixed Value: h |
frequency | S | 1..1 | positiveInt | Fixed Value: 1 |
action:sliceValidateEICR | S | 1..1 | BackboneElement | Validate eICR |
id | S | 1..1 | string | Fixed Value: validate-eicr |
description | S | 1..1 | string | Description of the "validate-eicr" action. Fixed Value: This action represents the validation of an eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: Validate eICR. |
trigger | S | 1..1 | TriggerDefinition | Trigger when the eICR has been created. |
type | 1..1 | code | Fixed Value: data-changed | |
name | S | 1..1 | string | Fixed Value: eicr-created |
data | S | 1..1 | DataRequirement | |
type | S | 1..1 | code | Fixed Value: Composition |
profile | S | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition |
action:sliceRouteAndSendEICR | S | 1..1 | BackboneElement | Route and send eICR |
id | S | 1..1 | string | 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 an eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: Route and send eICR |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: validate-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | SI | 0..* | PlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the plan definition |
version | SΣI | 1..1 | string | Business version of the eRSD |
name | SΣI | 1..1 | string | Name for this eRSD (computer friendly) |
title | SΣI | 1..1 | string | Title for this eRSD |
subtitle | I | 0..1 | string | Subordinate title of the plan definition |
type | SΣI | 0..1 | CodeableConcept | Type of this eRSD Binding: PlanDefinitionType (extensible) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | I | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣI | 1..1 | dateTime | Date the eRSD was published |
publisher | ΣI | 0..1 | string | Name of the agency that published this eRSD |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | ΣI | 0..1 | markdown | Natural language description of the plan definition |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | I | 0..1 | markdown | Why this plan definition is defined |
usage | I | 0..1 | string | Describes the clinical usage of the plan |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the plan definition was approved by publisher |
lastReviewDate | I | 0..1 | date | When the plan definition was last reviewed |
effectivePeriod | SΣI | 0..1 | Period | When the eRSD is expected to be used |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
start | ΣI | 1..1 | dateTime | The start of the time period when this eRSD goes in effect |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example) |
author | I | 0..* | ContactDetail | Who authored the content |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations |
library | SI | 0..* | canonical(Library) | Logic used by the plan definition |
goal | I | 0..* | BackboneElement | What the plan is trying to accomplish |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | I | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example) |
description | I | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example) |
priority | I | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
start | I | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
addresses | I | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example) |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the goal |
target | I | 0..* | BackboneElement | Target outcome for the goal |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | I | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example) |
detail[x] | I | 0..1 | The target value to be achieved | |
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | I | 0..1 | Duration | Reach goal within |
action | SI | 1..* | (Slice Definition) | Action defined by the plan 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | I | 0..1 | string | Brief description of the action |
textEquivalent | I | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action A sub-action | |
action:sliceMatchTrigger | SI | 1..1 | BackboneElement | Match trigger code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: match-trigger |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "match-trigger" action. Fixed Value: This action represents the matching of a trigger code to one of the values in the eRSD value sets. |
textEquivalent | SI | 1..1 | string | Text equivalent of the "match-trigger" action. Fixed Value: Match of a code to one of the values in the eRSD value sets. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..* | TriggerDefinition | When the "match-trigger" action should be triggered. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-changed |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..* | DataRequirement | A triggering value set. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | The type of trigger data. Binding: FHIRAllTypes (required) |
profile | ΣI | 0..* | canonical(StructureDefinition) | The profile of the required data |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | SΣI | 1..1 | Element | Match based on code. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | SΣI | 1..1 | string | Path to the code to match |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 1..1 | canonical(eRSD Value Set) | eRSD value set containing trigger codes. |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceMatchTrigger A sub-action | |
action:sliceCreateEICR | SI | 1..1 | BackboneElement | Create eICR |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "create-eicr" action. Fixed Value: This action represents the initial creation of the eICR. |
textEquivalent | SI | 1..1 | string | Text equivalent of the "create-ecir" action. Fixed Value: eICR construction delay (offsetDuration.value = x hours) - time after trigger event before an eICR should be created. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: match-trigger |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Duration | Time offset for the relationship Example for initial delay duration of 1 hour: {"value":1,"unit":"h"} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
value | SΣI | 1..1 | decimal | [x - value] |
comparator | ?!ΣI | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
unit | SΣI | 1..1 | string | Unit representation Fixed Value: h |
system | ΣI | 0..1 | uri | System that defines coded unit form |
code | ΣI | 0..1 | code | Coded form of the unit |
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceCreateEICR A sub-action | |
action:slicePeriodicUpdateEICR | SI | 1..1 | BackboneElement | Periodic Update of eICR |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: periodic-update-eicr | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the periodic update of the eICR. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: eICR periodic update (repeat.frequency = y hours) - the time after an initial eICR creation to send a new eICR as an update during long encounters. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | Trigger every y hours after first eICR creation. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: periodic |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | SΣI | 1..1 | Timing | Timing of the event Example for periodic update: {"repeat":{"frequency":1,"period":24,"periodUnit":"h"}} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | ΣI | 0..* | dateTime | When the event occurs |
repeat | SΣI | 1..1 | Element | Repeat update of eICR every [y - period] hours. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
bounds[x] | ΣI | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
count | ΣI | 0..1 | positiveInt | Number of times to repeat |
countMax | ΣI | 0..1 | positiveInt | Maximum number of times to repeat |
duration | ΣI | 0..1 | decimal | How long when it happens |
durationMax | ΣI | 0..1 | decimal | How long when it happens (Max) |
durationUnit | ΣI | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
frequency | SΣI | 1..1 | positiveInt | Event occurs frequency times per period Fixed Value: 1 |
frequencyMax | ΣI | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣI | 1..1 | decimal | [y - period] |
periodMax | ΣI | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣI | 1..1 | code | Unit - hours Binding: UnitsOfTime (required) Fixed Value: h |
dayOfWeek | ΣI | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | ΣI | 0..* | time | Time of day for action |
when | ΣI | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) |
offset | ΣI | 0..1 | unsignedInt | Minutes from event (before or after) |
code | ΣI | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) |
data | ΣI | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | SI | 1..* | (Slice Definition) | Whether or not the action is applicable Slice: Unordered, Open by value:kind |
condition:All Slices | Content/Rules for all slices | |||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
condition:sliceStartCondition | SI | 1..1 | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) Fixed Value: start |
expression | SI | 1..1 | Expression | Boolean-valued expression |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
description | ΣI | 0..1 | string | Natural language description of the condition Fixed Value: Encounter is active. |
name | ΣI | 0..1 | id | Short name assigned to expression for reuse |
language | ΣI | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt Example CQL: text/cql |
expression | SΣI | 1..1 | string | Encounter started. Example CQL: encounter.period.start != null and encounter.period.end = null |
reference | ΣI | 0..1 | uri | Where the expression is found |
condition:sliceStopCondition | SI | 1..1 | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) Fixed Value: stop |
expression | SI | 1..1 | Expression | Boolean-valued expression |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
description | ΣI | 0..1 | string | Natural language description of the condition Fixed Value: Encounter is closed. |
name | ΣI | 0..1 | id | Short name assigned to expression for reuse |
language | ΣI | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt Example CQL: text/cql |
expression | SΣI | 1..1 | string | Encounter ended. Example CQL: encounter.period.end != null |
reference | ΣI | 0..1 | uri | Where the expression is found |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: create-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:slicePeriodicUpdateEICR A sub-action | |
action:sliceCloseOutEICR | SI | 1..1 | BackboneElement | Close Out eICR action |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: close-out-eicr | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "close-out-eicr" action. Fixed Value: This action represents the close out of an eICR encounter. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: eICR encounter close out (timingTiming.repeat.duration = z hours) - the time after the end of the encounter to create the final eICR when there have been one or more trigger events. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | When the action should be triggered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-added |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..1 | DataRequirement | Trigger when Encounter.period.end is added. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) Fixed Value: Encounter |
profile | SΣI | 1..1 | canonical(StructureDefinition) | The profile of the required data Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Valueset for the filter |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | SΣI | 1..1 | Element | What dates/date ranges are expected |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | SΣI | 1..1 | string | A date-valued attribute to filter on Fixed Value: period.end |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: create-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | SI | 1..1 | Timing | When the action should take place Example for close out duration of 24 hours after end of encounter: {"repeat":{"count":1,"duration":24,"durationUnit":"h","frequency":1}} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | ΣI | 0..* | dateTime | When the event occurs |
repeat | SΣI | 1..1 | Element | Close out eICR [z] hours after end of encounter. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
bounds[x] | ΣI | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
count | SΣI | 1..1 | positiveInt | Number of times to repeat Fixed Value: 1 |
countMax | ΣI | 0..1 | positiveInt | Maximum number of times to repeat |
duration | SΣI | 1..1 | decimal | [z - duration] |
durationMax | ΣI | 0..1 | decimal | How long when it happens (Max) |
durationUnit | SΣI | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) Fixed Value: h |
frequency | SΣI | 1..1 | positiveInt | Event occurs frequency times per period Fixed Value: 1 |
frequencyMax | ΣI | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | ΣI | 0..1 | decimal | Event occurs frequency times per period |
periodMax | ΣI | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | ΣI | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
dayOfWeek | ΣI | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | ΣI | 0..* | time | Time of day for action |
when | ΣI | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) |
offset | ΣI | 0..1 | unsignedInt | Minutes from event (before or after) |
code | ΣI | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) |
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceCloseOutEICR A sub-action | |
action:sliceValidateEICR | SI | 1..1 | BackboneElement | Validate eICR |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "validate-eicr" action. Fixed Value: This action represents the validation of an eICR. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Validate eICR. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | Trigger when the eICR has been created. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-changed |
name | SΣI | 1..1 | string | Name or URI that identifies the event Fixed Value: eicr-created |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..1 | DataRequirement | Triggering data of the event (multiple = 'and') |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | SΣI | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) Fixed Value: Composition |
profile | SΣI | 1..1 | canonical(StructureDefinition) | The profile of the required data Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Valueset for the filter |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceValidateEICR A sub-action | |
action:sliceRouteAndSendEICR | SI | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of an eICR. |
textEquivalent | SI | 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 | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: validate-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceRouteAndSendEICR A sub-action | |
Documentation for this format |
Summary
Mandatory: 66 elements (3 nested mandatory elements)
Must-Support: 69 elements
Fixed Value: 46 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element PlanDefinition.action is sliced based on the value of value:id (ordered)
- The element PlanDefinition.action.condition is sliced based on the value of value:kind
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 0..* | PlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
version | S | 1..1 | string | Business version of the eRSD |
name | S | 1..1 | string | Name for this eRSD (computer friendly) |
title | S | 1..1 | string | Title for this eRSD |
type | S | 0..1 | CodeableConcept | Type of this eRSD |
date | S | 1..1 | dateTime | Date the eRSD was published |
publisher | 0..1 | string | Name of the agency that published this eRSD | |
effectivePeriod | S | 0..1 | Period | When the eRSD is expected to be used |
start | 1..1 | dateTime | The start of the time period when this eRSD goes in effect | |
library | S | 0..* | canonical(Library) | |
action | S | 1..* | (Slice Definition) | Slice: Ordered, Open by value:id |
action:sliceMatchTrigger | S | 1..1 | BackboneElement | Match trigger code |
id | S | 1..1 | string | Fixed Value: match-trigger |
description | S | 1..1 | string | Description of the "match-trigger" action. Fixed Value: This action represents the matching of a trigger code to one of the values in the eRSD value sets. |
textEquivalent | S | 1..1 | string | Text equivalent of the "match-trigger" action. Fixed Value: Match of a code to one of the values in the eRSD value sets. |
trigger | S | 1..* | TriggerDefinition | When the "match-trigger" action should be triggered. |
type | 1..1 | code | Fixed Value: data-changed | |
data | S | 1..* | DataRequirement | A triggering value set. |
type | 1..1 | code | The type of trigger data. | |
codeFilter | S | 1..1 | Element | Match based on code. |
path | S | 1..1 | string | Path to the code to match |
valueSet | 1..1 | canonical(eRSD Value Set) | eRSD value set containing trigger codes. | |
action:sliceCreateEICR | S | 1..1 | BackboneElement | Create eICR |
id | S | 1..1 | string | Fixed Value: create-eicr |
description | S | 1..1 | string | Description of the "create-eicr" action. Fixed Value: This action represents the initial creation of the eICR. |
textEquivalent | S | 1..1 | string | Text equivalent of the "create-ecir" action. Fixed Value: eICR construction delay (offsetDuration.value = x hours) - time after trigger event before an eICR should be created. |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: match-trigger | |
relationship | 1..1 | code | Fixed Value: after | |
offset[x] | 0..1 | Duration | Example for initial delay duration of 1 hour: {"value":1,"unit":"h"} | |
value | S | 1..1 | decimal | [x - value] |
unit | S | 1..1 | string | Fixed Value: h |
action:slicePeriodicUpdateEICR | S | 1..1 | BackboneElement | Periodic Update of eICR |
id | 1..1 | string | Fixed Value: periodic-update-eicr | |
description | S | 1..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the periodic update of the eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: eICR periodic update (repeat.frequency = y hours) - the time after an initial eICR creation to send a new eICR as an update during long encounters. |
trigger | S | 1..1 | TriggerDefinition | Trigger every y hours after first eICR creation. |
type | 1..1 | code | Fixed Value: periodic | |
timing[x] | S | 1..1 | Timing | Example for periodic update: {"repeat":{"frequency":1,"period":24,"periodUnit":"h"}} |
repeat | S | 1..1 | Element | Repeat update of eICR every [y - period] hours. |
frequency | S | 1..1 | positiveInt | Fixed Value: 1 |
period | S | 1..1 | decimal | [y - period] |
periodUnit | S | 1..1 | code | Unit - hours Fixed Value: h |
condition | S | 1..* | (Slice Definition) | Slice: Unordered, Open by value:kind |
condition:sliceStartCondition | S | 1..1 | BackboneElement | |
kind | 1..1 | code | Fixed Value: start | |
expression | S | 1..1 | Expression | |
description | 0..1 | string | Fixed Value: Encounter is active. | |
language | 1..1 | code | Example CQL: text/cql | |
expression | S | 1..1 | string | Encounter started. Example CQL: encounter.period.start != null and encounter.period.end = null |
condition:sliceStopCondition | S | 1..1 | BackboneElement | |
kind | 1..1 | code | Fixed Value: stop | |
expression | S | 1..1 | Expression | |
description | 0..1 | string | Fixed Value: Encounter is closed. | |
language | 1..1 | code | Example CQL: text/cql | |
expression | S | 1..1 | string | Encounter ended. Example CQL: encounter.period.end != null |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: create-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
action:sliceCloseOutEICR | S | 1..1 | BackboneElement | Close Out eICR action |
id | 1..1 | string | Fixed Value: close-out-eicr | |
description | S | 1..1 | string | Description of the "close-out-eicr" action. Fixed Value: This action represents the close out of an eICR encounter. |
textEquivalent | S | 1..1 | string | Fixed Value: eICR encounter close out (timingTiming.repeat.duration = z hours) - the time after the end of the encounter to create the final eICR when there have been one or more trigger events. |
trigger | S | 1..1 | TriggerDefinition | |
type | 1..1 | code | Fixed Value: data-added | |
data | S | 1..1 | DataRequirement | Trigger when Encounter.period.end is added. |
type | 1..1 | code | Fixed Value: Encounter | |
profile | S | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter |
dateFilter | S | 1..1 | Element | |
path | S | 1..1 | string | Fixed Value: period.end |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: create-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
timing[x] | S | 1..1 | Timing | Example for close out duration of 24 hours after end of encounter: {"repeat":{"count":1,"duration":24,"durationUnit":"h","frequency":1}} |
repeat | S | 1..1 | Element | Close out eICR [z] hours after end of encounter. |
count | S | 1..1 | positiveInt | Fixed Value: 1 |
duration | S | 1..1 | decimal | [z - duration] |
durationUnit | S | 1..1 | code | Fixed Value: h |
frequency | S | 1..1 | positiveInt | Fixed Value: 1 |
action:sliceValidateEICR | S | 1..1 | BackboneElement | Validate eICR |
id | S | 1..1 | string | Fixed Value: validate-eicr |
description | S | 1..1 | string | Description of the "validate-eicr" action. Fixed Value: This action represents the validation of an eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: Validate eICR. |
trigger | S | 1..1 | TriggerDefinition | Trigger when the eICR has been created. |
type | 1..1 | code | Fixed Value: data-changed | |
name | S | 1..1 | string | Fixed Value: eicr-created |
data | S | 1..1 | DataRequirement | |
type | S | 1..1 | code | Fixed Value: Composition |
profile | S | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition |
action:sliceRouteAndSendEICR | S | 1..1 | BackboneElement | Route and send eICR |
id | S | 1..1 | string | 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 an eICR. |
textEquivalent | S | 1..1 | string | Fixed Value: Route and send eICR |
relatedAction | S | 1..1 | BackboneElement | |
actionId | 1..1 | id | Fixed Value: validate-eicr | |
relationship | 1..1 | code | Fixed Value: after | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | SI | 0..* | PlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the plan definition |
version | SΣI | 1..1 | string | Business version of the eRSD |
name | SΣI | 1..1 | string | Name for this eRSD (computer friendly) |
title | SΣI | 1..1 | string | Title for this eRSD |
subtitle | I | 0..1 | string | Subordinate title of the plan definition |
type | SΣI | 0..1 | CodeableConcept | Type of this eRSD Binding: PlanDefinitionType (extensible) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | I | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣI | 1..1 | dateTime | Date the eRSD was published |
publisher | ΣI | 0..1 | string | Name of the agency that published this eRSD |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | ΣI | 0..1 | markdown | Natural language description of the plan definition |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | I | 0..1 | markdown | Why this plan definition is defined |
usage | I | 0..1 | string | Describes the clinical usage of the plan |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the plan definition was approved by publisher |
lastReviewDate | I | 0..1 | date | When the plan definition was last reviewed |
effectivePeriod | SΣI | 0..1 | Period | When the eRSD is expected to be used |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
start | ΣI | 1..1 | dateTime | The start of the time period when this eRSD goes in effect |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
topic | I | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example) |
author | I | 0..* | ContactDetail | Who authored the content |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 0..* | RelatedArtifact | Additional documentation, citations |
library | SI | 0..* | canonical(Library) | Logic used by the plan definition |
goal | I | 0..* | BackboneElement | What the plan is trying to accomplish |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | I | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example) |
description | I | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example) |
priority | I | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
start | I | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
addresses | I | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example) |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the goal |
target | I | 0..* | BackboneElement | Target outcome for the goal |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | I | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example) |
detail[x] | I | 0..1 | The target value to be achieved | |
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | I | 0..1 | Duration | Reach goal within |
action | SI | 1..* | (Slice Definition) | Action defined by the plan 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | I | 0..1 | string | Brief description of the action |
textEquivalent | I | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action A sub-action | |
action:sliceMatchTrigger | SI | 1..1 | BackboneElement | Match trigger code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: match-trigger |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "match-trigger" action. Fixed Value: This action represents the matching of a trigger code to one of the values in the eRSD value sets. |
textEquivalent | SI | 1..1 | string | Text equivalent of the "match-trigger" action. Fixed Value: Match of a code to one of the values in the eRSD value sets. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..* | TriggerDefinition | When the "match-trigger" action should be triggered. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-changed |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..* | DataRequirement | A triggering value set. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | The type of trigger data. Binding: FHIRAllTypes (required) |
profile | ΣI | 0..* | canonical(StructureDefinition) | The profile of the required data |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | SΣI | 1..1 | Element | Match based on code. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | SΣI | 1..1 | string | Path to the code to match |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 1..1 | canonical(eRSD Value Set) | eRSD value set containing trigger codes. |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceMatchTrigger A sub-action | |
action:sliceCreateEICR | SI | 1..1 | BackboneElement | Create eICR |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-eicr |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "create-eicr" action. Fixed Value: This action represents the initial creation of the eICR. |
textEquivalent | SI | 1..1 | string | Text equivalent of the "create-ecir" action. Fixed Value: eICR construction delay (offsetDuration.value = x hours) - time after trigger event before an eICR should be created. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: match-trigger |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Duration | Time offset for the relationship Example for initial delay duration of 1 hour: {"value":1,"unit":"h"} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
value | SΣI | 1..1 | decimal | [x - value] |
comparator | ?!ΣI | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
unit | SΣI | 1..1 | string | Unit representation Fixed Value: h |
system | ΣI | 0..1 | uri | System that defines coded unit form |
code | ΣI | 0..1 | code | Coded form of the unit |
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceCreateEICR A sub-action | |
action:slicePeriodicUpdateEICR | SI | 1..1 | BackboneElement | Periodic Update of eICR |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: periodic-update-eicr | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the periodic update of the eICR. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: eICR periodic update (repeat.frequency = y hours) - the time after an initial eICR creation to send a new eICR as an update during long encounters. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | Trigger every y hours after first eICR creation. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: periodic |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | SΣI | 1..1 | Timing | Timing of the event Example for periodic update: {"repeat":{"frequency":1,"period":24,"periodUnit":"h"}} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | ΣI | 0..* | dateTime | When the event occurs |
repeat | SΣI | 1..1 | Element | Repeat update of eICR every [y - period] hours. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
bounds[x] | ΣI | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
count | ΣI | 0..1 | positiveInt | Number of times to repeat |
countMax | ΣI | 0..1 | positiveInt | Maximum number of times to repeat |
duration | ΣI | 0..1 | decimal | How long when it happens |
durationMax | ΣI | 0..1 | decimal | How long when it happens (Max) |
durationUnit | ΣI | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
frequency | SΣI | 1..1 | positiveInt | Event occurs frequency times per period Fixed Value: 1 |
frequencyMax | ΣI | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣI | 1..1 | decimal | [y - period] |
periodMax | ΣI | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣI | 1..1 | code | Unit - hours Binding: UnitsOfTime (required) Fixed Value: h |
dayOfWeek | ΣI | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | ΣI | 0..* | time | Time of day for action |
when | ΣI | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) |
offset | ΣI | 0..1 | unsignedInt | Minutes from event (before or after) |
code | ΣI | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) |
data | ΣI | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | SI | 1..* | (Slice Definition) | Whether or not the action is applicable Slice: Unordered, Open by value:kind |
condition:All Slices | Content/Rules for all slices | |||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
condition:sliceStartCondition | SI | 1..1 | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) Fixed Value: start |
expression | SI | 1..1 | Expression | Boolean-valued expression |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
description | ΣI | 0..1 | string | Natural language description of the condition Fixed Value: Encounter is active. |
name | ΣI | 0..1 | id | Short name assigned to expression for reuse |
language | ΣI | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt Example CQL: text/cql |
expression | SΣI | 1..1 | string | Encounter started. Example CQL: encounter.period.start != null and encounter.period.end = null |
reference | ΣI | 0..1 | uri | Where the expression is found |
condition:sliceStopCondition | SI | 1..1 | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) Fixed Value: stop |
expression | SI | 1..1 | Expression | Boolean-valued expression |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
description | ΣI | 0..1 | string | Natural language description of the condition Fixed Value: Encounter is closed. |
name | ΣI | 0..1 | id | Short name assigned to expression for reuse |
language | ΣI | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt Example CQL: text/cql |
expression | SΣI | 1..1 | string | Encounter ended. Example CQL: encounter.period.end != null |
reference | ΣI | 0..1 | uri | Where the expression is found |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: create-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:slicePeriodicUpdateEICR A sub-action | |
action:sliceCloseOutEICR | SI | 1..1 | BackboneElement | Close Out eICR action |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: close-out-eicr | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "close-out-eicr" action. Fixed Value: This action represents the close out of an eICR encounter. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: eICR encounter close out (timingTiming.repeat.duration = z hours) - the time after the end of the encounter to create the final eICR when there have been one or more trigger events. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | When the action should be triggered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-added |
name | ΣI | 0..1 | string | Name or URI that identifies the event |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..1 | DataRequirement | Trigger when Encounter.period.end is added. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) Fixed Value: Encounter |
profile | SΣI | 1..1 | canonical(StructureDefinition) | The profile of the required data Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Valueset for the filter |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | SΣI | 1..1 | Element | What dates/date ranges are expected |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | SΣI | 1..1 | string | A date-valued attribute to filter on Fixed Value: period.end |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: create-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | SI | 1..1 | Timing | When the action should take place Example for close out duration of 24 hours after end of encounter: {"repeat":{"count":1,"duration":24,"durationUnit":"h","frequency":1}} |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | ΣI | 0..* | dateTime | When the event occurs |
repeat | SΣI | 1..1 | Element | Close out eICR [z] hours after end of encounter. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
bounds[x] | ΣI | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
count | SΣI | 1..1 | positiveInt | Number of times to repeat Fixed Value: 1 |
countMax | ΣI | 0..1 | positiveInt | Maximum number of times to repeat |
duration | SΣI | 1..1 | decimal | [z - duration] |
durationMax | ΣI | 0..1 | decimal | How long when it happens (Max) |
durationUnit | SΣI | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) Fixed Value: h |
frequency | SΣI | 1..1 | positiveInt | Event occurs frequency times per period Fixed Value: 1 |
frequencyMax | ΣI | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | ΣI | 0..1 | decimal | Event occurs frequency times per period |
periodMax | ΣI | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | ΣI | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
dayOfWeek | ΣI | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | ΣI | 0..* | time | Time of day for action |
when | ΣI | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) |
offset | ΣI | 0..1 | unsignedInt | Minutes from event (before or after) |
code | ΣI | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) |
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceCloseOutEICR A sub-action | |
action:sliceValidateEICR | SI | 1..1 | BackboneElement | Validate eICR |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-eicr |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the "validate-eicr" action. Fixed Value: This action represents the validation of an eICR. |
textEquivalent | SI | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Validate eICR. |
priority | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | SI | 1..1 | TriggerDefinition | Trigger when the eICR has been created. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | ΣI | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required) Fixed Value: data-changed |
name | SΣI | 1..1 | string | Name or URI that identifies the event Fixed Value: eicr-created |
timing[x] | ΣI | 0..1 | Timing of the event | |
timingTiming | Timing | |||
timingReference | Reference(Schedule) | |||
timingDate | date | |||
timingDateTime | dateTime | |||
data | SΣI | 1..1 | DataRequirement | Triggering data of the event (multiple = 'and') |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
type | SΣI | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required) Fixed Value: Composition |
profile | SΣI | 1..1 | canonical(StructureDefinition) | The profile of the required data Fixed Value: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition |
subject[x] | ΣI | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | ΣI | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A coded (token) parameter to search on |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Valueset for the filter |
code | ΣI | 0..* | Coding | What code is expected |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣI | 0..1 | string | A date valued parameter to search on |
value[x] | ΣI | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueDuration | Duration | |||
limit | ΣI | 0..1 | positiveInt | Number of results |
sort | ΣI | 0..* | Element | Order of the results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
path | ΣI | 1..1 | string | The name of the attribute to perform the sort |
direction | ΣI | 1..1 | code | ascending | descending Binding: SortDirection (required) |
condition | ΣI | 0..1 | Expression | Whether the event triggers (boolean expression) |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceValidateEICR A sub-action | |
action:sliceRouteAndSendEICR | SI | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | I | 0..1 | string | User-visible title |
description | SI | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of an eICR. |
textEquivalent | SI | 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 | I | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
reason | I | 0..* | CodeableConcept | Why the action should be performed |
documentation | I | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
goalId | I | 0..* | id | What goals this action supports |
subject[x] | I | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | I | 0..* | TriggerDefinition | When the action should be triggered |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
input | I | 0..* | DataRequirement | Input data requirements |
output | I | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 1..1 | BackboneElement | Relationship to another action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action is this related to Fixed Value: validate-eicr |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) Fixed Value: after |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | I | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) |
role | I | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example) |
type | I | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | I | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
definition[x] | I | 0..1 | Description of the activity to be performed | |
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||
definitionUri | uri | |||
transform | I | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | I | 0..1 | string | The path to the element to be set dynamically |
expression | I | 0..1 | Expression | An expression that provides the dynamic value for the customization |
action | I | 0..* | Unknown reference to #PlanDefinition.action:sliceRouteAndSendEICR A sub-action | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron