Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot
Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 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-relateddata-extension-example"/>
<meta>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition"/>
</meta>
<language value="en"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<table class="narrative-table">
<tbody>
<tr>
<th colspan="2" scope="row" class="row-header">Metadata</th>
</tr>
<tr>
<th scope="row" class="row-header">Title</th>
<td class="content-container">eRSD PlanDefinition Instance Simple Example</td>
</tr>
<tr>
<th scope="row" class="row-header">Version</th>
<td class="content-container">3.0.0-ballot</td>
</tr>
<tr>
<th scope="row" class="row-header">Identifier</th>
<td class="content-container">urn:oid:2.16.840.1.113883.4.642.40.46.34.5</td>
</tr>
<tr>
<th scope="row" class="row-header">Experimental</th>
<td class="content-container">true</td>
</tr>
<tr>
<th scope="row" class="row-header">Jurisdiction</th>
<td class="content-container">
US from <a href="https://en.wikipedia.org/wiki/ISO_3166-2">urn:iso:std:iso:3166</a>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Steward (Publisher)</th>
<td class="content-container">HL7 International / Public Health</td>
</tr>
<tr>
<th scope="row" class="row-header">Steward Contact</th>
<td class="content-container">HL7 International / Public Health</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container"><div><p>Example of an eRSD PlanDefinition demonstrating the use of the US Public Health RelatedData Extension for linking related resources.</p>
</div></td>
</tr>
<tr>
<th scope="row" class="row-header">Type</th>
<td class="content-container">
Workflow Definition
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">start-workflow</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the start of the reporting workflow in response to the encounter-start event.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Start the reporting workflow in response to an encounter-start event</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
Initiate a reporting workflow
</td>
</tr>
<tr>
<th scope="row" class="row-header">Trigger Type</th>
<td class="content-container">Named Event</td>
</tr>
<tr>
<th scope="row" class="row-header">Trigger Name</th>
<td class="content-container">encounter-start</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Patient
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Encounter
<br/>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">check-suspected-disorder</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check suspected disorders for immediate reportability and setup jobs for future reportability checks.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
execute-reporting-workflow from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-suspected-disorder)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-suspected-disorder</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the check for suspected disorder reportability to create the patients eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check Trigger Codes based on Suspected Reportable Value set.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
check-trigger-codes from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-suspected-disorder</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the check for suspected disorder reportability to create the patients eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check Trigger Codes based on Suspected Reportable Value set.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
check-trigger-codes from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-suspected-disorder)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">continue-check-reportable</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">continue-check-reportable</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">check-reportable</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the check for suspected reportability of the eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check Reportability and setup jobs for future reportability checks.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
execute-reporting-workflow from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-reportable</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the check for reportability to create the patients eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check Trigger Codes based on RCTC Value sets.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
check-trigger-codes from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-reportable</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the check for reportability to create the patients eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Check Trigger Codes based on RCTC Value sets.</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
check-trigger-codes from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">check-update-eicr</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">check-update-eicr</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-in-progress</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-in-progress</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
evaluate-condition from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-completed</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
complete-reporting from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Sub-Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">is-encounter-completed</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
complete-reporting from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">create-eicr</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the creation of the eICR. It subsequently calls validate.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Create eICR</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
create-report from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Patient
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html">US Core Patient Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Condition
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html">US Core Condition Encounter Diagnosis Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Encounter
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html">US Core Encounter Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: MedicationRequest
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html">US Core MedicationRequest Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Immunization
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-immunization.html">US Core Immunization Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Procedure
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-procedure.html">US Core Procedure Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Observation
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: ServiceRequest
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/R4/servicerequest.html">ServiceRequest</a>
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: DiagnosticReport
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-lab.html">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: DiagnosticReport
<br/>
<em>Profile(s)</em>:
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-lab.html">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> version: 6.1.0
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Output Data Requirement</th>
<td class="content-container">
<em>Type</em>: Bundle
<br/>
<em>Profile(s)</em>:
<a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a>
<br/>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">validate-eicr</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the validation of the eICR. It subsequently calls route-and-send.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Validate eICR</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
validate-report from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Bundle
<br/>
<em>Profile(s)</em>:
<a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a>
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Output Data Requirement</th>
<td class="content-container">
<em>Type</em>: Bundle
<br/>
<em>Profile(s)</em>:
<a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a>
<br/>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">route-and-send-eicr</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the routing and sending of the eICR.</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Route and send eICR</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
submit-report from <a href="http://hl7.org/fhir/us/ph-library/2.0.0-snapshot/CodeSystem-us-ph-codesystem-plandefinition-actions.html">http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions</a>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Input Data Requirement</th>
<td class="content-container">
<em>Type</em>: Bundle
<br/>
<em>Profile(s)</em>:
<a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a>
<br/>
</td>
</tr>
<tr>
<th scope="row" class="row-header">Output Data Requirement</th>
<td class="content-container">
<em>Type</em>: Bundle
<br/>
<em>Profile(s)</em>:
<a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a>
<br/>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">PlanDefinition Action</th>
</tr>
<tr>
<th scope="row" class="row-header">Id</th>
<td class="content-container">encounter-modified</td>
</tr>
<tr>
<th scope="row" class="row-header">Description</th>
<td class="content-container">This action represents the start of the reporting workflow in response to the encounter-modified event</td>
</tr>
<tr>
<th scope="row" class="row-header">Human-interpretable Description</th>
<td class="content-container">Start the reporting workflow in response to an encounter-modified event</td>
</tr>
<tr>
<th scope="row" class="row-header">Code</th>
<td class="content-container">
Initiate a reporting workflow
</td>
</tr>
<tr>
<th scope="row" class="row-header">Trigger Type</th>
<td class="content-container">Named Event</td>
</tr>
<tr>
<th scope="row" class="row-header">Trigger Name</th>
<td class="content-container">encounter-modified</td>
</tr>
<tr>
<th scope="row" class="row-header">Condition</th>
<td class="content-container">
<em>Kind</em>: Applicability
<br/>
</td>
</tr>
<tr>
<th colspan="2" scope="row" class="row-header">Generated using version 0.5.4 of the sample-content-ig Liquid templates</th>
</tr>
</tbody>
</table>
</div>
</text>
<extension url="http://hl7.org/fhir/StructureDefinition/variable">
<valueExpression>
<name value="normalReportingDuration"/>
<language value="text/fhirpath"/>
<expression value="2 weeks"/>
</valueExpression>
</extension>
<url
value="http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-relateddata-extension-example"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.46.34.5"/>
</identifier>
<version value="3.0.0-ballot"/>
<name value="PlanDefinition_eRSD_Instance_Simple_Example"/>
<title value="eRSD PlanDefinition Instance Simple 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="Example of an eRSD PlanDefinition demonstrating the use of the US Public Health RelatedData Extension for linking related resources."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<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="patient-data">
<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="condition-data">
<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="encounter-data">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="encounters"/>
</extension>
<type value="Encounter"/>
<profile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|6.1.0"/>
</input>
<input id="mr-data">
<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="immz-data">
<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="proc-data">
<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="labResult-data">
<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="labOrder-data">
<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"/>
</input>
<input id="diagnosticResult-data">
<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="diagnosticOrder-data">
<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="eicr-report">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
</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="generated-eicr-report">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="eicr-report"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
</input>
<output id="valid-eicr-report">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
</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="validated-eicr-report">
<extension
url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension">
<valueString value="valid-eicr-report"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
</input>
<output id="submitted-eicr-report">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
</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>
<language value="text/fhirpath"/>
<expression
value="%encounter.where(period.start + %normalReportingDuration < now())"/>
</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
2026-04-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change