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.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. 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 plandefinition-ersd-instance-simple-example

Variable: 2 weeks(normalReportingDuration)

url: PlanDefinition eRSD PlanDefinition Instance Simple Example

identifier: Uniform Resource Identifier (URI)/urn:oid:2.16.840.1.113883.4.642.40.46.34.4

version: 2.1.2

name: PlanDefinition_eRSD_Instance_Simple_Example

title: eRSD PlanDefinition Instance Simple Example

type: 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

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
trigger
id
encounter-start
US Public Health Named Event Type Extension: Indicates the start of an encounter
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 No display for Duration (value: 1; system: http://unitsofmeasure.org; code: 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
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
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %modifiedConditions.exists() or %modifiedLabResults.exists() or %modifiedMedicationOrders.exists()
input
id
modifiedConditions
US Public Health FHIR Query Pattern Extension: Condition?patient=Patient/{{context.patientId}}
type: Condition
CodeFilters
- Path ValueSet
* code Example Suspected Disorder Triggers for Public Health Reporting
input
id
modifiedLabResults
US Public Health FHIR Query Pattern Extension: Observation?patient=Patient/{{context.patientId}}
type: Observation
CodeFilters
- Path ValueSet
* value Example Lab Order Test Triggers for Public Health Reporting
input
id
modifiedMedicationOrders
US Public Health FHIR Query Pattern Extension: MedicationRequest?patient=Patient/{{context.patientId}}
type: MedicationRequest
CodeFilters
- Path ValueSet
* medication Example Medications Triggers for Public Health Reporting
RelatedActions
- ActionId Relationship
* create-eicr Before Start
action
id
continue-check-reportable
code: Evaluate condition to determine reportability
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %encounter.where((status = 'in-progress' and period.start + %normalReportingDuration < now()) or status = 'finished' and period.end <= now() - 72 hours)
RelatedActions
- ActionId Relationship Offset[x]
* check-reportable Before Start No display for Duration (value: 6; comparator: <=; system: http://unitsofmeasure.org; code: h)

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
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
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %encounter.where(period.start + %normalReportingDuration >= now()) and (%conditions.exists() or %encounters.exists() or %immunizations.exists() or %procedures.exists() or %procedureOrders.exists() or %labOrders.exists() or %labTests.exists() or %labResults.exists() or %medicationAdministrations.exists() or %medicationOrders.exists() or %medicationDispenses.exists())
input
id
conditions
US Public Health FHIR Query Pattern Extension: Condition?patient=Patient/{{context.patientId}}
type: Condition
CodeFilters
- Path ValueSet
* code Example Diagnosis Problem Triggers for Public Health Reporting
input
id
encounters
US Public Health Related Data Extension: encounter
type: Encounter
CodeFilters
- Path ValueSet
* reasonCode Example Diagnosis Problem Triggers for Public Health Reporting
input
id
immunizations
US Public Health FHIR Query Pattern Extension: Immunization?patient=Patient/{{context.patientId}}
type: Immunization
CodeFilters
- Path ValueSet
* vaccineCode Example Medications Triggers for Public Health Reporting
input
id
labOrders
US Public Health FHIR Query Pattern Extension: ServiceRequest?patient=Patient/{{context.patientId}}
type: ServiceRequest
CodeFilters
- Path ValueSet
* code Example Lab Order Test Triggers for Public Health Reporting
input
id
labTests
US Public Health FHIR Query Pattern Extension: Observation?patient=Patient/{{context.patientId}}
type: Observation
CodeFilters
- Path ValueSet
* code Example Lab Order Test Triggers for Public Health Reporting
input
id
diagnosticOrders
US Public Health FHIR Query Pattern Extension: DiagnosticReport?patient=Patient/{{context.patientId}}
type: DiagnosticReport
CodeFilters
- Path ValueSet
* code Example Lab Order Test Triggers for Public Health Reporting
input
id
procedureOrders
US Public Health FHIR Query Pattern Extension: ServiceRequest?patient=Patient/{{context.patientId}}
type: ServiceRequest
CodeFilters
- Path ValueSet
* code Example Procedure Triggers for Public Health Reporting
input
id
procedures
US Public Health FHIR Query Pattern Extension: Procedure?patient=Patient/{{context.patientId}}
type: Procedure
CodeFilters
- Path ValueSet
* code Example Procedure Triggers for Public Health Reporting
input
id
medicationOrders
US Public Health FHIR Query Pattern Extension: MedicationRequest?patient=Patient/{{context.patientId}}
type: MedicationRequest
CodeFilters
- Path ValueSet
* medication Example Medications Triggers for Public Health Reporting
input
id
medicationDispenses
US Public Health FHIR Query Pattern Extension: MedicationDispense?patient=Patient/{{context.patientId}}
type: MedicationDispense
CodeFilters
- Path ValueSet
* medication Example Medications Triggers for Public Health Reporting
input
id
medicationAdministrations
US Public Health FHIR Query Pattern Extension: MedicationAdministration?patient=Patient/{{context.patientId}}
type: MedicationAdministration
CodeFilters
- Path ValueSet
* medication Example Medications Triggers for Public Health Reporting
input
id
labResults
US Public Health Related Data Extension: labTests
type: Observation
CodeFilters
- Path ValueSet
* value Example Organism Substance Triggers for Public Health Reporting
input
id
diagnosticResults
US Public Health Related Data Extension: diagnosticOrders
type: DiagnosticReport
CodeFilters
- Path ValueSet
* code Example Organism Substance Triggers for Public Health Reporting
RelatedActions
- ActionId Relationship
* create-eicr Before Start
action
id
check-update-eicr
code: Evaluate condition to determine reportability
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %last-eicr.last().entry.first().resource.date < now() - 72 hours
input
id
last-eicr
US Public Health Related Data Extension: eicr-report
type: Bundle
profile: eICR Document Bundle
RelatedActions
- ActionId Relationship
* create-eicr Before Start
action
id
is-encounter-in-progress
code: Evaluate condition to determine reportability
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %`inprogress-encounter`.where(status = 'in-progress' and period.start + %normalReportingDuration >= now() and period.end <= now() - 72 hours)
input
id
inprogress-encounter
US Public Health Related Data Extension: encounter
type: Encounter
RelatedActions
- ActionId Relationship Offset[x]
* check-reportable Before Start No display for Duration (value: 6; comparator: <=; system: http://unitsofmeasure.org; code: h)
action
id
is-encounter-completed
code: Complete reporting for the patient
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %completedEncounter.exists(status = 'finished')
input
id
completedEncounter
US Public Health Related Data Extension: encounter
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
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.
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
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
trigger
id
encounter-modified-trigger
US Public Health Named Event Type Extension: Indicates modifications to data elements of an encounter
type: Named Event
name: encounter-modified
condition
kind: Applicability
Expressions
- Language Expression
* FHIRPath %encounter.where(period.start + %normalReportingDuration < now())
RelatedActions
- ActionId Relationship
* create-eicr Before Start