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. For a full list of available versions, see the Directory of published versions

: Central Cancer Registry PlanDefinition - Example - JSON Representation

Draft as of 2020-11-04

Raw json | Download


{
  "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\"><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",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.40.34.1"
    }
  ],
  "version" : "1.0.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 International / Public Health",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This is the Healthcare Survey Reporting Knowledge Artifact",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "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"
    }
  ],
  "action" : [
    {
      "id" : "start-workflow",
      "description" : "This action represents the start of the reporting workflow in response to the encounter-end event",
      "textEquivalent" : "Start the reporting workflow in response to an encounter-end event",
      "code" : [
        {
          "coding" : [
            {
              "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
              "code" : "initiate-reporting-workflow"
            }
          ]
        }
      ],
      "trigger" : [
        {
          "id" : "encounter-close",
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents",
                    "code" : "encounter-end",
                    "display" : "Indicates the end of an encounter"
                  }
                ]
              }
            }
          ],
          "type" : "named-event",
          "name" : "encounter-end"
        }
      ],
      "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/medmorph/CodeSystem/us-ph-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/medmorph/CodeSystem/us-ph-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/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                  "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"
                }
              ]
            }
          ],
          "relatedAction" : [
            {
              "actionId" : "report-cancer-data",
              "relationship" : "before-start"
            }
          ]
        },
        {
          "id" : "should-continue-reporting",
          "code" : [
            {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-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/medmorph/CodeSystem/us-ph-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/medmorph/CodeSystem/us-ph-plandefinition-actions",
                  "code" : "create-report"
                }
              ]
            }
          ],
          "input" : [
            {
              "id" : "patient",
              "type" : "Patient",
              "profile" : [
                🔗 "http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/cancer-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/cancer-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"
              ]
            }
          ],
          "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/medmorph/CodeSystem/us-ph-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/medmorph/CodeSystem/us-ph-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"
              ]
            }
          ]
        }
      ]
    }
  ]
}