Central Cancer Registry Reporting Content IG
2.0.0-ballot - STU 2 Ballot United States of America flag

Central Cancer Registry Reporting Content IG, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.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/fhir-central-cancer-registry-reporting-ig/ and changes regularly. See the Directory of published versions

: CCRR Specification Bundle - Example - XML Representation

Raw xml | Download


<Bundle xmlns="http://hl7.org/fhir">
  <id value="ccrr-specification-bundle-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-specification-bundle"/>
  </meta>
  <type value="collection"/>
  <timestamp value="2020-11-20T11:15:33-10:00"/>
  <entry>
    <fullUrl
             value="http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes-example"/>
    <resource>
      <ValueSet>
        <id value="cancer-core-reportability-codes-example"/>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><a name="ValueSet_cancer-core-reportability-codes-example"> </a><p class="res-header-id"><b>Generated Narrative: ValueSet cancer-core-reportability-codes-example</b></p><p>This value set includes codes based on the following rules:</p><ul><li>Include these codes as defined in <a href="http://www.snomed.org/"><code>http://snomed.info/sct</code></a><table class="none"><tr><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td></tr><tr><td><a href="http://snomed.info/id/281566005">281566005</a></td><td/></tr><tr><td><a href="http://snomed.info/id/403901001">403901001</a></td><td/></tr><tr><td><a href="http://snomed.info/id/254654004">254654004</a></td><td/></tr></table></li><li>Include these codes as defined in <a><code>http://hl7.org/fhir/sid/icd-10-cm</code></a><table class="none"><tr><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td></tr><tr><td>C00</td><td style="color: #cccccc">Malignant neoplasm of lip</td></tr><tr><td>C00.0</td><td style="color: #cccccc">Malignant neoplasm of external upper lip</td></tr></table></li></ul></div>
        </text>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/artifact-author">
          <valueContactDetail>
            <name value="Example Author"/>
          </valueContactDetail>
        </extension>
        <url
             value="http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes-example"/>
        <identifier>
          <system value="urn:ietf:rfc:3986"/>
          <value value="urn:oid:2.16.840.1.113883.4.642.40.40.48.1"/>
        </identifier>
        <version value="1.0.0"/>
        <name value="CancerCoreReportabilityCodes"/>
        <title value="Cancer Core Reportability Codes"/>
        <status value="active"/>
        <experimental value="false"/>
        <date value="2021-11-22"/>
        <publisher value="HL7 International / Public Health"/>
        <contact>
          <telecom>
            <system value="url"/>
            <value value="http://www.hl7.org/Special/committees/pher"/>
          </telecom>
        </contact>
        <description
                     value="The valueset contains SNOMED-CT and ICD-10-CM codes for Central Cancer Registry Reportability determination. These are just sample codes and the actual value set will be    published by the Central Cancer Registry."/>
        <useContext>
          <code>
            <system
                    value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type"/>
            <code value="priority"/>
            <display value="Priority"/>
          </code>
          <valueCodeableConcept>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context"/>
              <code value="triggering"/>
              <display value="Triggering"/>
            </coding>
          </valueCodeableConcept>
        </useContext>
        <jurisdiction>
          <coding>
            <system value="urn:iso:std:iso:3166"/>
            <code value="US"/>
          </coding>
        </jurisdiction>
        <copyright
                   value="This value set includes content from:
  1. This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement.  2. ICD-9 and ICD-10 are copyrighted by the World Health Organization (WHO) which owns and publishes the classification. See https://www.who.int/classifications/icd/en. WHO has authorized the development of an adaptation of ICD-9 and ICD-10 to ICD-9-CM to ICD-10-CM for use in the United States for U.S. government purposes.
"/>
        <compose>
          <include>
            <system value="http://snomed.info/sct"/>
            <concept>
              <code value="281566005"/>
              <display value="Abdominothoracic neuroblastoma (disorder)"/>
            </concept>
            <concept>
              <code value="403901001"/>
              <display
                       value="Acantholytic squamous cell carcinoma (disorder)"/>
            </concept>
            <concept>
              <code value="254654004"/>
              <display
                       value="Acantholytic squamous cell carcinoma of skin (disorder)"/>
            </concept>
          </include>
        </compose>
      </ValueSet>
    </resource>
  </entry>
  <entry>
    <fullUrl
             value="http://hl7.org/fhir/us/central-cancer-registry-reporting/PlanDefinition/plandefinition-central-cancer-registry-reporting-example"/>
    <resource>
      <PlanDefinition>
        <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"><a name="PlanDefinition_plandefinition-central-cancer-registry-reporting-example"> </a><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"/>
        <version value="1.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 Public Health Work Group"/>
        <description
                     value="This is the Cancer Registry Reporting Knowledge Artifact"/>
        <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|2.0.0"/>
        </relatedArtifact>
        <action id="start-workflow">
          <description
                       value="This action represents the start of the reporting workflow in response to the encounter-close event"/>
          <textEquivalent
                          value="Start the reporting workflow in response to an encounter-close event"/>
          <code>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
              <code value="initiate-reporting-workflow"/>
            </coding>
          </code>
          <trigger id="encounter-close">
            <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-close"/>
                  <display value="Indicates the close of an encounter"/>
                </coding>
              </valueCodeableConcept>
            </extension>
            <type value="named-event"/>
            <name value="encounter-close"/>
          </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/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 patient's cancer report."/>
            <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>
            <condition>
              <kind value="applicability"/>
              <expression>
                <language value="text/fhirpath"/>
                <expression value="%conditions.exists()"/>
              </expression>
            </condition>
            <input id="conditions">
              <extension
                         url="http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern">
                <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|2.0.0"/>
              </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/ph-library/CodeSystem/us-ph-codesystem-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/ph-library/CodeSystem/us-ph-codesystem-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/ph-library/CodeSystem/us-ph-codesystem-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/central-cancer-registry-reporting-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/central-cancer-registry-reporting-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|6.1.0"/>
            </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/ph-library/CodeSystem/us-ph-codesystem-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/ph-library/CodeSystem/us-ph-codesystem-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>
    </resource>
  </entry>
</Bundle>