HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

: eRSD PlanDefinition Instance Simple Example - XML Representation

Raw xml | Download



<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="plandefinition-ersd-instance-simple-example"/>
  <meta>
    <versionId value="2"/>
    <lastUpdated value="2021-11-17T04:21:04.742+00:00"/>
    <source value="#RGrNVmUZUqLjGmiG"/>
    <profile
             value="http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource "plandefinition-ersd-instance-simple-example" Version "2" Updated "2021-11-17T04:21:04.742Z" </p><p style="margin-bottom: 0px">Information Source: #RGrNVmUZUqLjGmiG!</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-ersd-plandefinition.html">eRSD PlanDefinition</a></p></div><p><b>url</b>: <code>http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-simple-example</code></p><p><b>version</b>: 2.0.0</p><p><b>name</b>: PlanDefinition_eRSD_Instance_Simple_Example</p><p><b>title</b>: eRSD PlanDefinition Instance Simple Example</p><p><b>type</b>: Workflow Definition <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.0.0/CodeSystem-plan-definition-type.html">PlanDefinitionType</a>#workflow-definition)</span></p><p><b>status</b>: active</p><p><b>experimental</b>: true</p><p><b>date</b>: 2020-07-31T12:32:29.858-05:00</p><p><b>publisher</b>: HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)</p><p><b>contact</b>: HL7 International - Public Health: <a href="http://www.hl7.org/Special/committees/pher">http://www.hl7.org/Special/committees/pher</a></p><p><b>description</b>: An example ersd PlanDefinition</p><p><b>jurisdiction</b>: United States of America <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (unknown#US)</span></p><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the start of the reporting workflow in response to the encounter-start event</p><p><b>textEquivalent</b>: Start the reporting workflow in response to an encounter-start event</p><p><b>code</b>: Initiate a reporting workflow <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#initiate-reporting-workflow)</span></p><h3>RelatedActions</h3><table class="grid"><tr><td>-</td><td><b>ActionId</b></td><td><b>Relationship</b></td><td><b>Offset[x]</b></td></tr><tr><td>*</td><td>check-reportable</td><td>before-start</td><td>60 s<span style="background: LightGoldenRodYellow"> (Details: UCUM code s = 's')</span></td></tr></table></blockquote><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the check for suspected reportability of the eICR.</p><p><b>textEquivalent</b>: Check Reportability and setup jobs for future reportability checks.</p><p><b>code</b>: Execute a series of actions to accomplish reporting <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#execute-reporting-workflow)</span></p><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the check for reportability to create the patients eICR.</p><p><b>textEquivalent</b>: Check Trigger Codes based on RCTC Value sets.</p><p><b>code</b>: Evaluate candidate patient's data against trigger codes to determine reportability <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#check-trigger-codes)</span></p></blockquote><blockquote><p><b>action</b></p><p><b>code</b>: Evaluate condition to determine reportability <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#evaluate-condition)</span></p></blockquote><blockquote><p><b>action</b></p><p><b>code</b>: Evaluate condition to determine reportability <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#evaluate-condition)</span></p></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the creation, validation and submission of the eICR.</p><p><b>textEquivalent</b>: Create, Validate and Report eICR set of actions</p><p><b>code</b>: Execute a series of actions to accomplish reporting <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#execute-reporting-workflow)</span></p><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the creation of the eICR.</p><p><b>textEquivalent</b>: Create eICR</p><p><b>code</b>: Create a Report containing Patient's data for patients who passed the check-reportability test <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#create-report)</span></p></blockquote><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the validation of the eICR.</p><p><b>textEquivalent</b>: Validate eICR</p><p><b>code</b>: Validate Report against specified profiles and terminologies. <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#validate-report)</span></p></blockquote><blockquote><p><b>action</b></p><p><b>description</b>: This action represents the routing and sending of the eICR.</p><p><b>textEquivalent</b>: Route and send eICR</p><p><b>code</b>: Submit the report to specified endpoint <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-plandefinition-actions.html">US Public Health PlanDefinition Action Codes</a>#submit-report)</span></p></blockquote></blockquote></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-simple-example"/>
  <version value="2.0.0"/>
  <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 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)"/>
  <contact>
    <name value="HL7 International - Public Health"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description value="An example ersd PlanDefinition"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
    <text value="United States of America"/>
  </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/ecr/CodeSystem/us-ph-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/ecr/StructureDefinition/us-ph-named-eventtype-extension">
        <valueCodeableConcept>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-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>
    <relatedAction>
      <actionId value="check-reportable"/>
      <relationship value="before-start"/>
      <offsetDuration>
        <value value="60"/>
        <system value="http://unitsofmeasure.org"/>
        <code value="s"/>
      </offsetDuration>
    </relatedAction>
  </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/ecr/CodeSystem/us-ph-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/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="check-trigger-codes"/>
        </coding>
      </code>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/fhirpath"/>
          <expression
                      value="%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()"/>
        </expression>
      </condition>
      <input id="conditions">
        <type value="Condition"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-dxtc-example"/>
        </codeFilter>
      </input>
      <input id="encounters">
        <type value="Encounter"/>
        <codeFilter>
          <path value="reasonCode"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-dxtc-example"/>
        </codeFilter>
      </input>
      <input id="immunizations">
        <type value="Immunization"/>
        <codeFilter>
          <path value="vaccineCode"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"/>
        </codeFilter>
      </input>
      <input id="labOrders">
        <type value="ServiceRequest"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-lotc-example"/>
        </codeFilter>
      </input>
      <input id="labTests">
        <type value="Observation"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-lotc-example"/>
        </codeFilter>
      </input>
      <input id="procedureOrders">
        <type value="ServiceRequest"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-pctc-example"/>
        </codeFilter>
      </input>
      <input id="procedures">
        <type value="Procedure"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-pctc-example"/>
        </codeFilter>
      </input>
      <input id="medicationOrders">
        <type value="MedicationRequest"/>
        <codeFilter>
          <path value="medication"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"/>
        </codeFilter>
      </input>
      <input id="medicationDispenses">
        <type value="MedicationDispense"/>
        <codeFilter>
          <path value="medication"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"/>
        </codeFilter>
      </input>
      <input id="medicationAdministrations">
        <type value="MedicationAdministration"/>
        <codeFilter>
          <path value="medication"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"/>
        </codeFilter>
      </input>
      <input id="labResults">
        <type value="Observation"/>
        <codeFilter>
          <path value="value"/>
          <valueSet
                    value="http://hl7.org/fhir/us/ecr/ValueSet/valueset-ostc-example"/>
        </codeFilter>
      </input>
      <relatedAction>
        <actionId value="report-eicr"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="check-update-eicr">
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="evaluate-condition"/>
        </coding>
      </code>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/fhirpath"/>
          <expression
                      value="Composition.where(code = &#39;http://loinc.org#55751-2&#39;).last().date &lt; now() - 24 hours"/>
        </expression>
      </condition>
      <relatedAction>
        <actionId value="report-eicr"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="is-encounter-in-progress">
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="evaluate-condition"/>
        </coding>
      </code>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/fhirpath"/>
          <expression
                      value="%encounter.where(status = &#39;in-progress&#39; and period.end &lt;= now() - 72 hours)"/>
        </expression>
      </condition>
      <relatedAction>
        <actionId value="check-reportable"/>
        <relationship value="before-start"/>
        <offsetDuration>
          <value value="6"/>
          <system value="http://unitsofmeasure.org"/>
          <code value="h"/>
        </offsetDuration>
      </relatedAction>
    </action>
  </action>
  <action id="report-eicr">
    <description
                 value="This action represents the creation, validation and submission of the eICR."/>
    <textEquivalent value="Create, Validate and Report eICR set of actions"/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
        <code value="execute-reporting-workflow"/>
      </coding>
    </code>
    <action id="create-eicr">
      <description value="This action represents the creation of the eICR."/>
      <textEquivalent value="Create eICR"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="create-report"/>
        </coding>
      </code>
      <input id="patient">
        <type value="Patient"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
      </input>
      <input id="condition">
        <type value="Condition"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"/>
      </input>
      <input id="encounter">
        <type value="Encounter"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/>
      </input>
      <input id="mr">
        <type value="MedicationRequest"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
      </input>
      <input id="immz">
        <type value="Immunization"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"/>
      </input>
      <input id="proc">
        <type value="Procedure"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"/>
      </input>
      <input id="obs">
        <type value="Observation"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/vitalsigns"/>
      </input>
      <input id="svcr">
        <type value="ServiceRequest"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/>
      </input>
      <output id="eicr-report-output">
        <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."/>
      <textEquivalent value="Validate eICR"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="validate-report"/>
        </coding>
      </code>
      <input id="eicr-report-input">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
      </input>
      <output id="validated-eicr-report-output">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
      </output>
      <relatedAction>
        <actionId value="submit-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/ecr/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="submit-report"/>
        </coding>
      </code>
      <input id="validated-eicr-report-input">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
      </input>
      <output id="eicr-report-submitted">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
      </output>
    </action>
  </action>
</PlanDefinition>