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 |
{
"resourceType" : "PlanDefinition",
"id" : "plandefinition-ersd-instance-simple-example",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition"
]
},
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table class=\"narrative-table\">\n <tbody>\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">Metadata</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Title</th>\n\n\n\n<td class=\"content-container\">eRSD PlanDefinition Instance Simple Example</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Version</th>\n\n\n\n<td class=\"content-container\">3.0.0-ballot</td>\n\n\n</tr>\n\n\n\n\n\n\n\n \n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Identifier</th>\n\n\n\n<td class=\"content-container\">urn:oid:2.16.840.1.113883.4.642.40.46.34.4</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Experimental</th>\n\n\n\n<td class=\"content-container\">true</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Jurisdiction</th>\n\n\n\n<td class=\"content-container\">\n US from <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2\">urn:iso:std:iso:3166</a> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Steward (Publisher)</th>\n\n\n\n<td class=\"content-container\">HL7 International / Public Health</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Steward Contact</th>\n\n\n\n<td class=\"content-container\">HL7 International / Public Health</td>\n\n\n</tr>\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\"><div><p>An example ersd PlanDefinition</p>\n</div></td>\n\n\n</tr>\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Type</th>\n\n\n\n<td class=\"content-container\">\n Workflow Definition\n\n\n</td>\n\n\n</tr>\n\n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">start-workflow</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the start of the reporting workflow in response to the encounter-start event.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Start the reporting workflow in response to an encounter-start event</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n Initiate a reporting workflow\n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Trigger Type</th>\n\n\n\n<td class=\"content-container\">Named Event</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Trigger Name</th>\n\n\n\n<td class=\"content-container\">encounter-start</td>\n\n\n</tr>\n\n\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Patient\n <br/>\n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Encounter\n <br/>\n \n \n \n </td>\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">check-suspected-disorder</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check suspected disorders for immediate reportability and setup jobs for future reportability checks.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-suspected-disorder)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-suspected-disorder</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the check for suspected disorder reportability to create the patients eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check Trigger Codes based on Suspected Reportable Value set.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-suspected-disorder</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the check for suspected disorder reportability to create the patients eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check Trigger Codes based on Suspected Reportable Value set.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-suspected-disorder)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">continue-check-reportable</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">continue-check-reportable</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">check-reportable</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the check for suspected reportability of the eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check Reportability and setup jobs for future reportability checks.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-reportable</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the check for reportability to create the patients eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check Trigger Codes based on RCTC Value sets.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-reportable</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the check for reportability to create the patients eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Check Trigger Codes based on RCTC Value sets.</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">check-update-eicr</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">check-update-eicr</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-in-progress</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-in-progress</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action (Parent Action ID: check-reportable)</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-completed</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Sub-Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">is-encounter-completed</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">create-eicr</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the creation of the eICR. It subsequently calls validate.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Create eICR</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Patient\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a> version: 6.1.0\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Condition\n <br/>\n \n <em>Profile(s)</em>: \n \n <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\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Encounter\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html\">US Core Encounter Profile</a> version: 6.1.0\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: MedicationRequest\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a> version: 6.1.0\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Immunization\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a> version: 6.1.0\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Procedure\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a> version: 6.1.0\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Observation\n <br/>\n \n <em>Profile(s)</em>: \n \n <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\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: ServiceRequest\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: DiagnosticReport\n <br/>\n \n <em>Profile(s)</em>: \n \n <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\n <br/> \n \n \n \n \n </td>\n</tr>\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: DiagnosticReport\n <br/>\n \n <em>Profile(s)</em>: \n \n <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\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Output Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Bundle\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"StructureDefinition-eicr-document-bundle.html\">eICR Document Bundle</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">validate-eicr</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the validation of the eICR. It subsequently calls route-and-send.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Validate eICR</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Bundle\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"StructureDefinition-eicr-document-bundle.html\">eICR Document Bundle</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Output Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Bundle\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"StructureDefinition-eicr-document-bundle.html\">eICR Document Bundle</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">route-and-send-eicr</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the routing and sending of the eICR.</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Route and send eICR</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n 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> \n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Input Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Bundle\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"StructureDefinition-eicr-document-bundle.html\">eICR Document Bundle</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Output Data Requirement</th>\n <td class=\"content-container\">\n <em>Type</em>: Bundle\n <br/>\n \n <em>Profile(s)</em>: \n \n <a href=\"StructureDefinition-eicr-document-bundle.html\">eICR Document Bundle</a>\n <br/> \n \n \n \n \n </td>\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<tr>\n\n\n<th colspan=\"2\" scope=\"row\" class=\"row-header\">PlanDefinition Action</th>\n\n\n</tr>\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Id</th>\n\n\n\n<td class=\"content-container\">encounter-modified</td>\n\n\n</tr>\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Description</th>\n\n\n\n<td class=\"content-container\">This action represents the start of the reporting workflow in response to the encounter-modified event</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Human-interpretable Description</th>\n\n\n\n<td class=\"content-container\">Start the reporting workflow in response to an encounter-modified event</td>\n\n\n</tr>\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Code</th>\n\n\n\n<td class=\"content-container\">\n Initiate a reporting workflow\n\n\n</td>\n\n\n</tr>\n\n\n\n\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Trigger Type</th>\n\n\n\n<td class=\"content-container\">Named Event</td>\n\n\n</tr>\n\n\n<tr>\n\n\n<th scope=\"row\" class=\"row-header\">Trigger Name</th>\n\n\n\n<td class=\"content-container\">encounter-modified</td>\n\n\n</tr>\n\n\n\n<tr>\n <th scope=\"row\" class=\"row-header\">Condition</th>\n <td class=\"content-container\">\n <em>Kind</em>: Applicability\n \n <br/>\n \n \n </td>\n</tr>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<tr>\n <th colspan=\"2\" scope=\"row\" class=\"row-header\">Generated using version 0.5.4 of the sample-content-ig Liquid templates</th>\n</tr>\n\n </tbody>\n </table>\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/variable",
"valueExpression" : {
"name" : "normalReportingDuration",
"language" : "text/fhirpath",
"expression" : "2 weeks"
}
}
],
"url" : "http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-simple-example",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.46.34.4"
}
],
"version" : "3.0.0-ballot",
"name" : "PlanDefinition_eRSD_Instance_Simple_Example",
"title" : "eRSD PlanDefinition Instance Simple Example",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "workflow-definition",
"display" : "Workflow Definition"
}
]
},
"status" : "active",
"experimental" : true,
"date" : "2020-07-31T12:32:29.858-05:00",
"publisher" : "HL7 International / Public Health",
"contact" : [
{
"name" : "HL7 International / Public Health",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pher"
},
{
"system" : "email",
"value" : "pher@lists.HL7.org"
}
]
}
],
"description" : "An example ersd PlanDefinition",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "initiate-reporting-workflow",
"display" : "Initiate a reporting workflow"
}
]
}
],
"trigger" : [
{
"id" : "encounter-start",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents",
"code" : "encounter-start",
"display" : "Indicates the start of an encounter"
}
]
}
}
],
"type" : "named-event",
"name" : "encounter-start"
}
],
"input" : [
{
"id" : "patient",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern",
"valueString" : "Patient/{{context.patientId}}"
}
],
"type" : "Patient"
},
{
"id" : "encounter",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern",
"valueString" : "Encounter/{{context.encounterId}}"
}
],
"type" : "Encounter"
}
],
"relatedAction" : [
{
"actionId" : "check-suspected-disorder",
"relationship" : "before-start",
"offsetDuration" : {
"value" : 1,
"system" : "http://unitsofmeasure.org",
"code" : "h"
}
}
]
},
{
"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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "check-trigger-codes"
}
]
}
]
},
{
"id" : "continue-check-reportable",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "evaluate-condition"
}
]
}
]
}
]
},
{
"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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "check-trigger-codes"
}
]
}
]
},
{
"id" : "check-update-eicr",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "evaluate-condition"
}
]
}
]
},
{
"id" : "is-encounter-in-progress",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "evaluate-condition"
}
]
}
]
},
{
"id" : "is-encounter-completed",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "complete-reporting"
}
]
}
]
}
]
},
{
"id" : "create-eicr",
"description" : "This action represents the creation of the eICR. It subsequently calls validate.",
"textEquivalent" : "Create eICR",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "create-report"
}
]
}
],
"input" : [
{
"id" : "patient-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "patient"
}
],
"type" : "Patient",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0"
]
},
{
"id" : "condition-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "conditions"
}
],
"type" : "Condition",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis|6.1.0"
]
},
{
"id" : "encounter-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "encounters"
}
],
"type" : "Encounter",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|6.1.0"
]
},
{
"id" : "mr-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "medicationOrders"
}
],
"type" : "MedicationRequest",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|6.1.0"
]
},
{
"id" : "immz-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "immunizations"
}
],
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|6.1.0"
]
},
{
"id" : "proc-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "procedures"
}
],
"type" : "Procedure",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|6.1.0"
]
},
{
"id" : "labResult-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "labResults"
}
],
"type" : "Observation",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|6.1.0"
]
},
{
"id" : "labOrder-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "labOrders"
}
],
"type" : "ServiceRequest",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/ServiceRequest"
]
},
{
"id" : "diagnosticResult-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "diagnosticResults"
}
],
"type" : "DiagnosticReport",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"
]
},
{
"id" : "diagnosticOrder-data",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "diagnosticOrders"
}
],
"type" : "DiagnosticReport",
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"
]
}
],
"output" : [
{
"id" : "eicr-report",
"type" : "Bundle",
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
]
}
],
"relatedAction" : [
{
"actionId" : "validate-eicr",
"relationship" : "before-start"
}
]
},
{
"id" : "validate-eicr",
"description" : "This action represents the validation of the eICR. It subsequently calls route-and-send.",
"textEquivalent" : "Validate eICR",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "validate-report"
}
]
}
],
"input" : [
{
"id" : "generated-eicr-report",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "eicr-report"
}
],
"type" : "Bundle",
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
]
}
],
"output" : [
{
"id" : "valid-eicr-report",
"type" : "Bundle",
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
]
}
],
"relatedAction" : [
{
"actionId" : "route-and-send-eicr",
"relationship" : "before-start"
}
]
},
{
"id" : "route-and-send-eicr",
"description" : "This action represents the routing and sending of the eICR.",
"textEquivalent" : "Route and send eICR",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "submit-report"
}
]
}
],
"input" : [
{
"id" : "validated-eicr-report",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "valid-eicr-report"
}
],
"type" : "Bundle",
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
]
}
],
"output" : [
{
"id" : "submitted-eicr-report",
"type" : "Bundle",
"profile" : [
🔗 "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
]
}
]
},
{
"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" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "initiate-reporting-workflow",
"display" : "Initiate a reporting workflow"
}
]
}
],
"trigger" : [
{
"id" : "encounter-modified-trigger",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents",
"code" : "encounter-modified",
"display" : "Indicates modifications to data elements of an encounter"
}
]
}
}
],
"type" : "named-event",
"name" : "encounter-modified"
}
],
"condition" : [
{
"kind" : "applicability",
"expression" : {
"language" : "text/fhirpath",
"expression" : "%encounter.where(period.start + %normalReportingDuration < now())"
}
}
],
"relatedAction" : [
{
"actionId" : "create-eicr",
"relationship" : "before-start"
}
]
}
]
}
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