eRSD PlanDefinition Instance Simple Example - HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR)

This page is part of the electronic Case Reporting (eCR) (v2.1.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in it's permanent location. For a full list of available versions, see the Directory of published versions

Example PlanDefinition: eRSD PlanDefinition Instance Simple Example

Active as of 2020-07-31

Generated Narrative: PlanDefinition

Resource PlanDefinition "plandefinition-ersd-instance-simple-example"

Profile: eRSD PlanDefinition

Variable: 2 weeks(normalReportingDuration)

wg: pher

url: http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-simple-example

version: 2.1.1

name: PlanDefinition_eRSD_Instance_Simple_Example

title: eRSD PlanDefinition Instance Simple Example

type: Workflow Definition (PlanDefinitionType#workflow-definition)

status: active

experimental: true

date: 2020-07-31 12:32:29-0500

publisher: HL7 International / Public Health

contact: HL7 International / Public Health: http://www.hl7.org/Special/committees/pher

description: An example ersd PlanDefinition

jurisdiction: United States of America (ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code#US)

action
id
start-workflow
description: This action represents the start of the reporting workflow in response to the encounter-start event.
textEquivalent: Start the reporting workflow in response to an encounter-start event
code: Initiate a reporting workflow (US Public Health PlanDefinition Action Codes#initiate-reporting-workflow)
trigger
id
encounter-start
US Public Health Named Event Type Extension: Indicates the start of an encounter (US Public Health TriggerDefinition NamedEvents#encounter-start)
type: named-event
name: encounter-start
input
id
patient
US Public Health FHIR Query Pattern Extension: Patient/{{context.patientId}}
type: Patient
input
id
encounter
US Public Health FHIR Query Pattern Extension: Encounter/{{context.encounterId}}
type: Encounter
RelatedActions
- ActionId Relationship Offset[x]
* check-suspected-disorder before-start 1 h (Details: UCUM code h = 'h')

action
id
check-suspected-disorder
description: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.
textEquivalent: Check suspected disorders for immediate reportability and setup jobs for future reportability checks.
code: Execute a series of actions to accomplish reporting (US Public Health PlanDefinition Action Codes#execute-reporting-workflow)
action
id
is-encounter-suspected-disorder
description: This action represents the check for suspected disorder reportability to create the patients eICR.
textEquivalent: Check Trigger Codes based on Suspected Reportable Value set.
code: Evaluate candidate patient's data against trigger codes to determine reportability (US Public Health PlanDefinition Action Codes#check-trigger-codes)
condition
input
Type: Condition
Filter Value
code In ValueSet Example Suspected Disorder Triggers for Public Health Reporting
input
Type: Observation
Filter Value
value In ValueSet Example Lab Order Test Triggers for Public Health Reporting
input
Type: MedicationRequest
Filter Value
medication In ValueSet Example Medications Triggers for Public Health Reporting
relatedAction
action
id
continue-check-reportable
code: Evaluate condition to determine reportability (US Public Health PlanDefinition Action Codes#evaluate-condition)
condition
relatedAction

action
id
check-reportable
description: This action represents the check for suspected reportability of the eICR.
textEquivalent: Check Reportability and setup jobs for future reportability checks.
code: Execute a series of actions to accomplish reporting (US Public Health PlanDefinition Action Codes#execute-reporting-workflow)
action
id
is-encounter-reportable
description: This action represents the check for reportability to create the patients eICR.
textEquivalent: Check Trigger Codes based on RCTC Value sets.
code: Evaluate candidate patient's data against trigger codes to determine reportability (US Public Health PlanDefinition Action Codes#check-trigger-codes)
condition
input
Type: Condition
Filter Value
code In ValueSet Example Diagnosis Problem Triggers for Public Health Reporting
input
Type: Encounter
Filter Value
reasonCode In ValueSet Example Diagnosis Problem Triggers for Public Health Reporting
input
Type: Immunization
Filter Value
vaccineCode In ValueSet Example Medications Triggers for Public Health Reporting
input
Type: ServiceRequest
Filter Value
code In ValueSet Example Lab Order Test Triggers for Public Health Reporting
input
Type: Observation
Filter Value
code In ValueSet Example Lab Order Test Triggers for Public Health Reporting
input
Type: DiagnosticReport
Filter Value
code In ValueSet Example Lab Order Test Triggers for Public Health Reporting
input
Type: ServiceRequest
Filter Value
code In ValueSet Example Procedure Triggers for Public Health Reporting
input
Type: Procedure
Filter Value
code In ValueSet Example Procedure Triggers for Public Health Reporting
input
Type: MedicationRequest
Filter Value
medication In ValueSet Example Medications Triggers for Public Health Reporting
input
Type: MedicationDispense
Filter Value
medication In ValueSet Example Medications Triggers for Public Health Reporting
input
Type: MedicationAdministration
Filter Value
medication In ValueSet Example Medications Triggers for Public Health Reporting
input
Type: Observation
Filter Value
value In ValueSet Example Organism Substance Triggers for Public Health Reporting
input
Type: DiagnosticReport
Filter Value
code In ValueSet Example Organism Substance Triggers for Public Health Reporting
relatedAction
action
id
check-update-eicr
code: Evaluate condition to determine reportability (US Public Health PlanDefinition Action Codes#evaluate-condition)
condition
input
Type: Bundle (eICR Document Bundle)
relatedAction
action
id
is-encounter-in-progress
code: Evaluate condition to determine reportability (US Public Health PlanDefinition Action Codes#evaluate-condition)
condition
input
Type: Encounter
relatedAction
action
id
is-encounter-completed
code: Complete reporting for the patient (US Public Health PlanDefinition Action Codes#complete-reporting)
condition
input
Type: Encounter

action
id
create-eicr
description: This action represents the creation of the eICR. It subsequently calls validate.
textEquivalent: Create eICR
code: Create a Report containing Patient's data for patients who passed the check-reportability test (US Public Health PlanDefinition Action Codes#create-report)
input
id
patient-data
US Public Health Related Data Extension: patient
type: Patient
profile: US Core Patient Profile
input
id
condition-data
US Public Health Related Data Extension: conditions
type: Condition
profile: US Core Condition Profile
input
id
encounter-data
US Public Health Related Data Extension: encounters
type: Encounter
profile: US Core Encounter Profile
input
id
mr-data
US Public Health Related Data Extension: medicationOrders
type: MedicationRequest
profile: US Core MedicationRequest Profile
input
id
immz-data
US Public Health Related Data Extension: immunizations
type: Immunization
profile: US Core Immunization Profile
input
id
proc-data
US Public Health Related Data Extension: procedures
type: Procedure
profile: US Core Procedure Profile
input
id
labResult-data
US Public Health Related Data Extension: labResults
type: Observation
profile: US Core Laboratory Result Observation Profile
input
id
labOrder-data
US Public Health Related Data Extension: labOrders
type: ServiceRequest
profile: ServiceRequest
input
id
diagnosticResult-data
US Public Health Related Data Extension: diagnosticResults
type: DiagnosticReport
profile: US Core DiagnosticReport Profile for Laboratory Results Reporting
input
id
diagnosticOrder-data
US Public Health Related Data Extension: diagnosticOrders
type: DiagnosticReport
profile: US Core DiagnosticReport Profile for Laboratory Results Reporting
output
id
eicr-report
type: Bundle
profile: eICR Document Bundle
RelatedActions
- ActionId Relationship
* validate-eicr before-start

action
id
validate-eicr
description: This action represents the validation of the eICR. It subsequently calls route-and-send.
textEquivalent: Validate eICR
code: Validate Report against specified profiles and terminologies. (US Public Health PlanDefinition Action Codes#validate-report)
input
id
generated-eicr-report
US Public Health Related Data Extension: eicr-report
type: Bundle
profile: eICR Document Bundle
output
id
valid-eicr-report
type: Bundle
profile: eICR Document Bundle
RelatedActions
- ActionId Relationship
* route-and-send-eicr before-start

action
id
route-and-send-eicr
description: This action represents the routing and sending of the eICR.
textEquivalent: Route and send eICR
code: Submit the report to specified endpoint (US Public Health PlanDefinition Action Codes#submit-report)
input
id
validated-eicr-report
US Public Health Related Data Extension: valid-eicr-report
type: Bundle
profile: eICR Document Bundle
output
id
submitted-eicr-report
type: Bundle
profile: eICR Document Bundle

action
id
encounter-modified
description: This action represents the start of the reporting workflow in response to the encounter-modified event
textEquivalent: Start the reporting workflow in response to an encounter-modified event
code: Initiate a reporting workflow (US Public Health PlanDefinition Action Codes#initiate-reporting-workflow)
trigger
id
encounter-modified-trigger
US Public Health Named Event Type Extension: Indicates modifications to data elements of an encounter (US Public Health TriggerDefinition NamedEvents#encounter-modified)
type: named-event
name: encounter-modified
condition
kind: applicability
Expressions
- Language Expression
* text/fhirpath %encounter.where(period.start + %normalReportingDuration < now())
RelatedActions
- ActionId Relationship
* create-eicr before-start