Central Cancer Registry Reporting Content IG
1.0.0 - STU 1 United States of America flag

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Central Cancer Registry Reporting Content IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Central Cancer Registry PlanDefinition - Example - XML Representation

Draft as of 2020-11-04

Raw xml | Download



<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="plandefinition-central-cancer-registry-reporting-example"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2020-11-29T02:03:28.045+00:00"/>
    <profile
             value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p><b>CCRR PlanDefinition Example</b></p></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/plandefinition-central-cancer-registry-reporting-example"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.40.34.1"/>
  </identifier>
  <version value="1.0.0"/>
  <name value="CentralCancerRegistryReportingExample"/>
  <title value="PlanDefinition Central Cancer Registry Reporting 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="draft"/>
  <experimental value="true"/>
  <date value="2020-11-04T12:32:29.858-05:00"/>
  <publisher value="HL7 International / Public Health"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description
               value="This is the Healthcare Survey Reporting Knowledge Artifact"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <effectivePeriod>
    <start value="2021-11-01"/>
  </effectivePeriod>
  <relatedArtifact>
    <type value="depends-on"/>
    <label value="Central Cancer Registry Trigger Codes"/>
    <resource
              value="http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes"/>
  </relatedArtifact>
  <action id="start-workflow">
    <description
                 value="This action represents the start of the reporting workflow in response to the encounter-end event"/>
    <textEquivalent
                    value="Start the reporting workflow in response to an encounter-end event"/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
        <code value="initiate-reporting-workflow"/>
      </coding>
    </code>
    <trigger id="encounter-close">
      <extension
                 url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype">
        <valueCodeableConcept>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents"/>
            <code value="encounter-end"/>
            <display value="Indicates the end of an encounter"/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <type value="named-event"/>
      <name value="encounter-end"/>
    </trigger>
    <relatedAction>
      <actionId value="check-reportable"/>
      <relationship value="before-start"/>
      <offsetDuration>
        <value value="72"/>
        <system value="http://unitsofmeasure.org"/>
        <code value="h"/>
      </offsetDuration>
    </relatedAction>
  </action>
  <action id="check-reportable">
    <description
                 value="This action represents the check for suspected reportability of the cancer data."/>
    <textEquivalent
                    value="Check Reportability and setup jobs for future reportability checks."/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/us/medmorph/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/medmorph/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()"/>
        </expression>
      </condition>
      <input id="conditions">
        <extension
                   url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
          <valueString
                       value="Condition?patient=Patient/{{context.patientId}}"/>
        </extension>
        <type value="Condition"/>
        <codeFilter>
          <path value="code"/>
          <valueSet
                    value="http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes"/>
        </codeFilter>
      </input>
      <relatedAction>
        <actionId value="report-cancer-data"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="should-continue-reporting">
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="evaluate-condition"/>
        </coding>
      </code>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/fhirpath"/>
          <expression
                      value="%patient.deceased[x] == null &amp;&amp; (currentTime - previousReportSubmissionTime) &lt; 7776000"/>
        </expression>
      </condition>
      <relatedAction>
        <actionId value="check-reportable"/>
        <relationship value="before-start"/>
        <offsetDuration>
          <value value="6"/>
          <system value="http://unitsofmeasure.org"/>
          <code value="mo"/>
        </offsetDuration>
      </relatedAction>
    </action>
  </action>
  <action id="report-cancer-data">
    <description
                 value="This action represents the creation, validation and submission of the cancer report."/>
    <textEquivalent
                    value="Check Reportability and setup jobs for future reportability checks."/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
        <code value="execute-reporting-workflow"/>
      </coding>
    </code>
    <action id="create-cancer-report">
      <description
                   value="This action represents the creation of the cancer report."/>
      <textEquivalent value="Central Cancer Registry Report"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="create-report"/>
        </coding>
      </code>
      <input id="patient">
        <type value="Patient"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/cancer-patient"/>
      </input>
      <input id="condition">
        <type value="Condition"/>
        <profile
                 value="http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-primary-cancer-condition"/>
      </input>
      <input id="encounter">
        <type value="Encounter"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/cancer-encounter"/>
      </input>
      <input id="mr">
        <type value="MedicationRequest"/>
        <profile
                 value="http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-request"/>
      </input>
      <input id="vitals">
        <type value="Observation"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/vitalsigns"/>
      </input>
      <input id="labs">
        <type value="Observation"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"/>
      </input>
      <output id="cancer-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"/>
      </output>
      <relatedAction>
        <actionId value="validate-report"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="validate-cancer-report">
      <description
                   value="This action represents the validation of the cancer report."/>
      <textEquivalent value="Validate Report"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="validate-report"/>
        </coding>
      </code>
      <input id="created-cancer-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"/>
      </input>
      <output id="validated-cancer-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"/>
      </output>
      <relatedAction>
        <actionId value="submit-report"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="route-and-send-cancer-report">
      <description
                   value="This action represents the routing and sending of the cancer report."/>
      <textEquivalent value="Route and send cancer report"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="submit-report"/>
        </coding>
      </code>
      <input id="val-cancer-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"/>
      </input>
    </action>
  </action>
</PlanDefinition>