Electronic Case Reporting (eCR)
3.0.0-ballot -
Electronic Case Reporting (eCR)
3.0.0-ballot -
Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
<PlanDefinition xmlns="http://hl7.org/fhir">
<id value="plandefinition-ersd-instance-example"/>
<meta>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition|3.0.0-ballot"/>
</meta>
<language value="en"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<div>
<table class="grid dict">
<tr>
<th scope="row"><b>Id: </b></th>
<td style="padding-left: 4px;">plandefinition-ersd-instance-example</td>
</tr>
<tr>
<th scope="row"><b>Url: </b></th>
<td style="padding-left: 4px;"><a href="PlanDefinition-plandefinition-ersd-instance-example.html">eRSD PlanDefinition Instance Example</a></td>
</tr>
<tr>
<th scope="row"><b>Version: </b></th>
<td style="padding-left: 4px;">3.0.0-ballot</td>
</tr>
<tr>
<th scope="row">
<b>
</b>
</th>
<td style="padding-left: 4px;">
<p style="margin-bottom: 5px;">
<span>urn:oid:2.16.840.1.113883.4.642.40.46.34.3</span>
</p>
</td>
</tr>
<tr>
<th scope="row"><b>Title: </b></th>
<td style="padding-left: 4px;">eRSD PlanDefinition Instance Example</td>
</tr>
<tr>
<th scope="row"><b>Experimental: </b></th>
<td style="padding-left: 4px;">true</td>
</tr>
<tr>
<th scope="row"><b>Type: </b></th>
<td style="padding-left: 4px;">
<p style="margin-bottom: 5px;">
<b>system: </b> <span><a href="http://terminology.hl7.org/7.0.0/CodeSystem-plan-definition-type.html">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>
</p>
<p style="margin-bottom: 5px;">
<b>code: </b> <span>workflow-definition</span>
</p>
<p style="margin-bottom: 5px;">
<b>display: </b> <span>Workflow Definition</span>
</p>
</td>
</tr>
<tr>
<th scope="row"><b>Date: </b></th>
<td style="padding-left: 4px;">2020-07-31 12:32:29-0500</td>
</tr>
<tr>
<th scope="row"><b>Publisher: </b></th>
<td style="padding-left: 4px;">HL7 International / Public Health</td>
</tr>
<tr>
<th scope="row"><b>Description: </b></th>
<td style="padding-left: 4px;"><div><p>An example ersd PlanDefinition</p>
</div></td>
</tr>
<tr>
<th scope="row"><b>Jurisdiction: </b></th>
<td style="padding-left: 4px;">US</td>
</tr>
<tr>
<th scope="row"><b>Effective Period: </b></th>
<td style="padding-left: 4px;">2020-12-01..</td>
</tr>
<tr>
<th scope="row"><b>Related Artifacts: </b></th>
<td style="padding-left: 4px;">
<p><b>Dependencies</b></p>
<ul>
<li><a href="Library-library-rctc-example.html">Reportable Condition Trigger Codes (RCTC) Example Libraryversion: null3.0.0-ballot)</a></li>
</ul>
</td>
</tr>
<tr>
<th scope="row"><b>Actions: </b></th>
<td style="padding-left: 4px;">
<table class="grid-dict">
<tr>
<td>
Start the reporting workflow in response to an encounter-start event
<br/>
<b>When:</b>
<i>Named Event:</i> encounter-start
<br/>
</td>
</tr>
<tr>
<td>
Check suspected disorders for immediate reportability and setup jobs for future reportability checks.
<br/>
<b>Then:</b>
<table class="grid-dict">
<tr>
<td>
Check Trigger Codes based on Suspected Reportable Value set.
<br/>
</td>
</tr>
<tr>
<td>
<b> :</b>
<br/>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
Check Reportability and setup jobs for future reportability checks.
<br/>
<b>Then:</b>
<table class="grid-dict">
<tr>
<td>
Check Trigger Codes based on RCTC Value sets.
<br/>
</td>
</tr>
<tr>
<td>
<b> :</b>
<br/>
</td>
</tr>
<tr>
<td>
<b> :</b>
<br/>
</td>
</tr>
<tr>
<td>
<b> :</b>
<br/>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
Create eICR
<br/>
</td>
</tr>
<tr>
<td>
Validate eICR
<br/>
</td>
</tr>
<tr>
<td>
Route and send eICR
<br/>
</td>
</tr>
<tr>
<td>
Start the reporting workflow in response to an encounter-modified event
<br/>
<b>When:</b>
<i>Named Event:</i> encounter-modified
<br/>
<b>If:</b>
<i>Applicability:</i>
<i>(%encounter.where(period.start + 1 day * %normalReportingDuration < now()).select(true))</i>
<br/>
</td>
</tr>
</table>
</td>
</tr>
</table>
</div>
</div>
</text>
<extension url="http://hl7.org/fhir/StructureDefinition/variable">
<valueExpression>
<name value="normalReportingDuration"/>
<language value="text/fhirpath"/>
<expression value="14"/>
</valueExpression>
</extension>
<url
value="http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-example"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.46.34.3"/>
</identifier>
<version value="3.0.0-ballot"/>
<name value="PlanDefinition_eRSD_Instance_Example"/>
<title value="eRSD PlanDefinition Instance Example"/>
<type>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
<code value="workflow-definition"/>
<display value="Workflow Definition"/>
</coding>
</type>
<status value="active"/>
<experimental value="true"/>
<date value="2020-07-31T12:32:29.858-05:00"/>
<publisher value="HL7 International / Public Health"/>
<contact>
<name value="HL7 International / Public Health"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/pher"/>
</telecom>
<telecom>
<system value="email"/>
<value value="pher@lists.HL7.org"/>
</telecom>
</contact>
<description value="An example ersd PlanDefinition"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<effectivePeriod>
<start value="2020-12-01"/>
</effectivePeriod>
<relatedArtifact>
<type value="depends-on"/>
<label value="RCTC Value Set Library of Trigger Codes"/>
<resource
value="http://hl7.org/fhir/us/ecr/Library/library-rctc-example|3.0.0-ballot"/>
</relatedArtifact>
<action id="start-workflow">
<description
value="This action represents the start of the reporting workflow in response to the encounter-start event."/>
<textEquivalent
value="Start the reporting workflow in response to an encounter-start event"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="initiate-reporting-workflow"/>
<display value="Initiate a reporting workflow"/>
</coding>
</code>
<trigger id="encounter-start">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension">
<valueCodeableConcept>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents"/>
<code value="encounter-start"/>
<display value="Indicates the start of an encounter"/>
</coding>
</valueCodeableConcept>
</extension>
<type value="named-event"/>
<name value="encounter-start"/>
</trigger>
<input id="patient">
<extension
url="http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern">
<valueString value="Patient/{{context.patientId}}"/>
</extension>
<type value="Patient"/>
</input>
<input id="encounter">
<extension
url="http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern">
<valueString value="Encounter/{{context.encounterId}}"/>
</extension>
<type value="Encounter"/>
</input>
<relatedAction>
<actionId value="check-suspected-disorder"/>
<relationship value="before-start"/>
<offsetDuration>
<value value="1"/>
<system value="http://unitsofmeasure.org"/>
<code value="h"/>
</offsetDuration>
</relatedAction>
</action>
<action id="check-suspected-disorder">
<description
value="This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."/>
<textEquivalent
value="Check suspected disorders for immediate reportability and setup jobs for future reportability checks."/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="execute-reporting-workflow"/>
</coding>
</code>
<action id="is-encounter-suspected-disorder">
<description
value="This action represents the check for suspected disorder reportability to create the patients eICR."/>
<textEquivalent
value="Check Trigger Codes based on Suspected Reportable Value set."/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="check-trigger-codes"/>
</coding>
</code>
</action>
<action id="continue-check-reportable">
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="evaluate-condition"/>
</coding>
</code>
</action>
</action>
<action id="check-reportable">
<description
value="This action represents the check for suspected reportability of the eICR."/>
<textEquivalent
value="Check Reportability and setup jobs for future reportability checks."/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="execute-reporting-workflow"/>
</coding>
</code>
<action id="is-encounter-reportable">
<description
value="This action represents the check for reportability to create the patients eICR."/>
<textEquivalent value="Check Trigger Codes based on RCTC Value sets."/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="check-trigger-codes"/>
</coding>
</code>
</action>
<action id="check-update-eicr">
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="evaluate-condition"/>
</coding>
</code>
</action>
<action id="is-encounter-in-progress">
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="evaluate-condition"/>
</coding>
</code>
</action>
<action id="is-encounter-completed">
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="complete-reporting"/>
</coding>
</code>
</action>
</action>
<action id="create-eicr">
<description
value="This action represents the creation of the eICR. It subsequently calls validate."/>
<textEquivalent value="Create eICR"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="create-report"/>
</coding>
</code>
<input id="patientdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="patient"/>
</extension>
<type value="Patient"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0"/>
</input>
<input id="conditiondata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="conditions"/>
</extension>
<type value="Condition"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis|6.1.0"/>
</input>
<input id="encounterdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="encounter"/>
</extension>
<type value="Encounter"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|6.1.0"/>
</input>
<input id="mrdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="medicationOrders"/>
</extension>
<type value="MedicationRequest"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|6.1.0"/>
</input>
<input id="immzdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="immunizations"/>
</extension>
<type value="Immunization"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|6.1.0"/>
</input>
<input id="procdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="procedures"/>
</extension>
<type value="Procedure"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|6.1.0"/>
</input>
<input id="labResultdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="labResults"/>
</extension>
<type value="Observation"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|6.1.0"/>
</input>
<input id="labOrderdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="labOrders"/>
</extension>
<type value="ServiceRequest"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/ServiceRequest|4.0.1"/>
</input>
<input id="diagnosticResultdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="diagnosticResults"/>
</extension>
<type value="DiagnosticReport"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"/>
</input>
<input id="diagnosticOrderdata">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="diagnosticOrders"/>
</extension>
<type value="DiagnosticReport"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"/>
</input>
<output id="eicrreport">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle|3.0.0-ballot"/>
</output>
<relatedAction>
<actionId value="validate-eicr"/>
<relationship value="before-start"/>
</relatedAction>
</action>
<action id="validate-eicr">
<description
value="This action represents the validation of the eICR. It subsequently calls route-and-send."/>
<textEquivalent value="Validate eICR"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="validate-report"/>
</coding>
</code>
<input id="generatedeicrreport">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="eicrreport"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle|3.0.0-ballot"/>
</input>
<output id="valideicrreport">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle|3.0.0-ballot"/>
</output>
<relatedAction>
<actionId value="route-and-send-eicr"/>
<relationship value="before-start"/>
</relatedAction>
</action>
<action id="route-and-send-eicr">
<description
value="This action represents the routing and sending of the eICR."/>
<textEquivalent value="Route and send eICR"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="submit-report"/>
</coding>
</code>
<input id="validatedeicrreport">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="valideicrreport"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle|3.0.0-ballot"/>
</input>
<output id="submittedeicrreport">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle|3.0.0-ballot"/>
</output>
</action>
<action id="encounter-modified">
<description
value="This action represents the start of the reporting workflow in response to the encounter-modified event"/>
<textEquivalent
value="Start the reporting workflow in response to an encounter-modified event"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
<code value="initiate-reporting-workflow"/>
<display value="Initiate a reporting workflow"/>
</coding>
</code>
<trigger id="encounter-modified-trigger">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension">
<valueCodeableConcept>
<coding>
<system
value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents"/>
<code value="encounter-modified"/>
<display
value="Indicates modifications to data elements of an encounter"/>
</coding>
</valueCodeableConcept>
</extension>
<type value="named-event"/>
<name value="encounter-modified"/>
</trigger>
<condition>
<kind value="applicability"/>
<expression>
<extension
url="http://hl7.org/fhir/StructureDefinition/cqf-alternativeExpression">
<valueExpression>🔗
<language value="text/cql-identifier"/>
<expression
value="Is Encounter Longer Than Normal Reporting Duration?"/>
<reference
value="http://hl7.org/fhir/us/ecr/Library/library-executable-rule-filters|2.1.0"/>
</valueExpression>
</extension>
<language value="text/fhirpath"/>
<expression
value="%encounter.where(period.start + 1 day * %normalReportingDuration < now()).select(true)"/>
</expression>
</condition>
<relatedAction>
<actionId value="create-eicr"/>
<relationship value="before-start"/>
</relatedAction>
</action>
</PlanDefinition>
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ecr#3.0.0-ballot based on FHIR 4.0.1.
Generated 2025-11-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change