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 - JSON Representation

Raw json | Download

{
  "resourceType" : "Bundle",
  "id" : "ccrr-specification-bundle-example",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2020-11-29T02:03:28.045+00:00",
    "profile" : [
      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-specification-bundle"
    ]
  },
  "type" : "collection",
  "timestamp" : "2020-11-20T11:15:33-10:00",
  "entry" : [
    {
      "fullUrl" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes-example",
      "resource" : {
        "resourceType" : "ValueSet",
        "id" : "cancer-core-reportability-codes-example",
        "text" : {
          "status" : "generated",
          "div" : "<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>"
        },
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/artifact-author",
            "valueContactDetail" : {
              "name" : "Example Author"
            }
          }
        ],
        "url" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes-example",
        "identifier" : [
          {
            "system" : "urn:ietf:rfc:3986",
            "value" : "urn:oid:2.16.840.1.113883.4.642.40.40.48.1"
          }
        ],
        "version" : "1.0.0",
        "name" : "CancerCoreReportabilityCodes",
        "title" : "Cancer Core Reportability Codes",
        "status" : "active",
        "experimental" : false,
        "date" : "2021-11-22",
        "publisher" : "HL7 International / Public Health",
        "contact" : [
          {
            "telecom" : [
              {
                "system" : "url",
                "value" : "http://www.hl7.org/Special/committees/pher"
              }
            ]
          }
        ],
        "description" : "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" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type",
              "code" : "priority",
              "display" : "Priority"
            },
            "valueCodeableConcept" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context",
                  "code" : "triggering",
                  "display" : "Triggering"
                }
              ]
            }
          }
        ],
        "jurisdiction" : [
          {
            "coding" : [
              {
                "system" : "urn:iso:std:iso:3166",
                "code" : "US"
              }
            ]
          }
        ],
        "copyright" : "This value set includes content from:\n  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.\n",
        "compose" : {
          "include" : [
            {
              "system" : "http://snomed.info/sct",
              "concept" : [
                {
                  "code" : "281566005",
                  "display" : "Abdominothoracic neuroblastoma (disorder)"
                },
                {
                  "code" : "403901001",
                  "display" : "Acantholytic squamous cell carcinoma (disorder)"
                },
                {
                  "code" : "254654004",
                  "display" : "Acantholytic squamous cell carcinoma of skin (disorder)"
                }
              ]
            }
          ]
        }
      }
    },
    {
      "fullUrl" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/PlanDefinition/plandefinition-central-cancer-registry-reporting-example",
      "resource" : {
        "resourceType" : "PlanDefinition",
        "id" : "plandefinition-central-cancer-registry-reporting-example",
        "meta" : {
          "versionId" : "1",
          "lastUpdated" : "2020-11-29T02:03:28.045+00:00",
          "profile" : [
            🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition"
          ]
        },
        "text" : {
          "status" : "extensions",
          "div" : "<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>"
        },
        "url" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/plandefinition-central-cancer-registry-reporting-example",
        "version" : "1.0",
        "name" : "CentralCancerRegistryReportingExample",
        "title" : "PlanDefinition Central Cancer Registry Reporting Example",
        "type" : {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
              "code" : "workflow-definition",
              "display" : "Workflow Definition"
            }
          ]
        },
        "status" : "draft",
        "experimental" : true,
        "date" : "2020-11-04T12:32:29.858-05:00",
        "publisher" : "HL7 Public Health Work Group",
        "description" : "This is the Cancer Registry Reporting Knowledge Artifact",
        "effectivePeriod" : {
          "start" : "2021-11-01"
        },
        "relatedArtifact" : [
          {
            "type" : "depends-on",
            "label" : "Central Cancer Registry Trigger Codes",
            "resource" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes|2.0.0"
          }
        ],
        "action" : [
          {
            "id" : "start-workflow",
            "description" : "This action represents the start of the reporting workflow in response to the encounter-close event",
            "textEquivalent" : "Start the reporting workflow in response to an encounter-close event",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                    "code" : "initiate-reporting-workflow"
                  }
                ]
              }
            ],
            "trigger" : [
              {
                "id" : "encounter-close",
                "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-close",
                          "display" : "Indicates the close of an encounter"
                        }
                      ]
                    }
                  }
                ],
                "type" : "named-event",
                "name" : "encounter-close"
              }
            ],
            "relatedAction" : [
              {
                "actionId" : "check-reportable",
                "relationship" : "before-start",
                "offsetDuration" : {
                  "value" : 72,
                  "system" : "http://unitsofmeasure.org",
                  "code" : "h"
                }
              }
            ]
          },
          {
            "id" : "check-reportable",
            "description" : "This action represents the check for suspected reportability of the cancer data.",
            "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 patient's cancer report.",
                "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"
                      }
                    ]
                  }
                ],
                "condition" : [
                  {
                    "kind" : "applicability",
                    "expression" : {
                      "language" : "text/fhirpath",
                      "expression" : "%conditions.exists()"
                    }
                  }
                ],
                "input" : [
                  {
                    "id" : "conditions",
                    "extension" : [
                      {
                        "url" : "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern",
                        "valueString" : "Condition?patient=Patient/{{context.patientId}}"
                      }
                    ],
                    "type" : "Condition",
                    "codeFilter" : [
                      {
                        "path" : "code",
                        "valueSet" : "http://hl7.org/fhir/us/central-cancer-registry-reporting/ValueSet/cancer-core-reportability-codes|2.0.0"
                      }
                    ]
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "report-cancer-data",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "should-continue-reporting",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                        "code" : "evaluate-condition"
                      }
                    ]
                  }
                ],
                "condition" : [
                  {
                    "kind" : "applicability",
                    "expression" : {
                      "language" : "text/fhirpath",
                      "expression" : "%patient.deceased[x] == null && (currentTime - previousReportSubmissionTime) < 7776000"
                    }
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "check-reportable",
                    "relationship" : "before-start",
                    "offsetDuration" : {
                      "value" : 6,
                      "system" : "http://unitsofmeasure.org",
                      "code" : "mo"
                    }
                  }
                ]
              }
            ]
          },
          {
            "id" : "report-cancer-data",
            "description" : "This action represents the creation, validation and submission of the cancer report.",
            "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" : "create-cancer-report",
                "description" : "This action represents the creation of the cancer report.",
                "textEquivalent" : "Central Cancer Registry Report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                        "code" : "create-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "patient",
                    "type" : "Patient",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/central-cancer-registry-reporting-patient"
                    ]
                  },
                  {
                    "id" : "condition",
                    "type" : "Condition",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-primary-cancer-condition"
                    ]
                  },
                  {
                    "id" : "encounter",
                    "type" : "Encounter",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/central-cancer-registry-reporting-encounter"
                    ]
                  },
                  {
                    "id" : "mr",
                    "type" : "MedicationRequest",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-request"
                    ]
                  },
                  {
                    "id" : "vitals",
                    "type" : "Observation",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/StructureDefinition/vitalsigns"
                    ]
                  },
                  {
                    "id" : "labs",
                    "type" : "Observation",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|6.1.0"
                    ]
                  }
                ],
                "output" : [
                  {
                    "id" : "cancer-report",
                    "type" : "Bundle",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"
                    ]
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "validate-report",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "validate-cancer-report",
                "description" : "This action represents the validation of the cancer report.",
                "textEquivalent" : "Validate Report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                        "code" : "validate-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "created-cancer-report",
                    "type" : "Bundle",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"
                    ]
                  }
                ],
                "output" : [
                  {
                    "id" : "validated-cancer-report",
                    "type" : "Bundle",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"
                    ]
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "submit-report",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "route-and-send-cancer-report",
                "description" : "This action represents the routing and sending of the cancer report.",
                "textEquivalent" : "Route and send cancer report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                        "code" : "submit-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "val-cancer-report",
                    "type" : "Bundle",
                    "profile" : [
                      🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-reporting-bundle"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}