description: 'This PlanDefinition profile defines the logic and rules around determining whether or not a cancer report should be generated and sent to a cancer registry. If the cancer condition is reportable, the PlanDefinition gives timing information, next steps and instructions for sending the cancer report to the cancer registry. The rules for determining reportability described by the Central Cancer Registry Reporting specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. '
package_name: hl7.fhir.us.central-cancer-registry-reporting
derivation: constraint
name: CentralCancerRegistryReportingPlanDefinition
type: PlanDefinition
elements:
  action:
    mustSupport: true
    array: true
    min: 2
    index: 0
    elements:
      code:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action'}
        mustSupport: true
        index: 1
      input: {index: 2}
    slicing:
      rules: open
      ordered: true
      discriminator:
      - {path: id, type: value}
      min: 2
      slices:
        encounterClose:
          match: {id: start-workflow}
          schema:
            short: Encounter Close Action
            mustSupport: true
            index: 3
            elements:
              id:
                pattern: {type: String, value: start-workflow}
                mustSupport: true
                index: 4
              description:
                short: Starts the workflow
                pattern: {type: String, value: This action represents the start of the reporting workflow in response to the encounter-close event}
                mustSupport: true
                index: 5
              textEquivalent:
                short: Text equivalent of the start workflow action.
                pattern: {type: String, value: Start the reporting workflow in response to an encounter-close event}
                mustSupport: true
                index: 6
              code:
                short: Code for the "start" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                index: 7
              trigger:
                short: When the "start" action should be triggered.
                mustSupport: true
                index: 8
                extensions:
                  namedEventType:
                    min: 0
                    isModifier: false
                    short: Indicates the types of named events to subscribe to from the EHR.
                    index: 10
                    type: Extension
                    mustSupport: true
                    max: 1
                    url: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                elements:
                  extension:
                    isModifier: false
                    short: Additional content defined by implementations
                    type: Extension
                    array: true
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                    index: 9
                    slicing:
                      rules: open
                      description: Extensions are always sliced by (at least) url
                      discriminator:
                      - {path: url, type: value}
                      min: 0
                      slices:
                        namedEventType:
                          match: {url: null}
                          schema:
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the EHR.
                            type: Extension
                            mustSupport: true
                            url: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                            index: 10
                          min: 0
                          max: 1
                  type:
                    pattern: {type: Code, value: named-event}
                    index: 11
                  name:
                    pattern: {type: String, value: encounter-close}
                    index: 12
              relatedAction:
                mustSupport: true
                index: 13
                elements:
                  actionId:
                    pattern: {type: Id, value: check-reportable}
                    index: 14
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 15
                  offsetDuration: {type: Duration, index: 16}
            required: [relatedAction, textEquivalent, id, trigger, code, description]
        checkReportable:
          match: {id: check-reportable}
          schema:
            _required: true
            index: 17
            elements:
              id:
                pattern: {type: String, value: check-reportable}
                mustSupport: true
                index: 18
              description:
                short: Check if the Encounter qualifies as check-reportable
                pattern: {type: String, value: This action represents the check for suspected reportability of the cancer data.}
                index: 19
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                index: 20
              action:
                array: true
                min: 2
                index: 21
                elements:
                  condition: {mustSupport: true, array: true, index: 22}
                  input: {mustSupport: true, array: true, index: 23}
                  output: {mustSupport: true, array: true, index: 24}
                  relatedAction: {mustSupport: true, array: true, index: 25}
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 2
                  slices:
                    isEncounterReportable:
                      match: {id: is-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 26
                        elements:
                          id:
                            pattern: {type: String, value: is-encounter-reportable}
                            mustSupport: true
                            index: 27
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: check-trigger-codes, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            index: 28
                          condition:
                            mustSupport: true
                            array: true
                            index: 29
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 30
                              expression:
                                mustSupport: true
                                index: 31
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 32
                            required: [expression]
                          input:
                            mustSupport: true
                            array: true
                            index: 33
                            elements:
                              id: {mustSupport: true, index: 34}
                            required: [id]
                          relatedAction:
                            index: 35
                            elements:
                              actionId:
                                pattern: {type: Id, value: report-cancer-data}
                                index: 36
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 37
                        required: [id, code]
                    shouldContinueReporting:
                      match: {id: should-continue-reporting}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 38
                        elements:
                          id:
                            pattern: {type: String, value: should-continue-reporting}
                            mustSupport: true
                            index: 39
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            index: 40
                          condition:
                            index: 41
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 42
                              expression:
                                mustSupport: true
                                index: 43
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 44
                            required: [expression]
                          relatedAction:
                            index: 45
                            elements:
                              actionId:
                                pattern: {type: Id, value: check-reportable}
                                index: 46
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 47
                              offsetDuration: {type: Duration, index: 48}
                        required: [id, code]
            required: [id, code]
        reportCancerData:
          match: {id: report-cancer-data}
          schema:
            index: 49
            elements:
              id:
                pattern: {type: String, value: report-cancer-data}
                mustSupport: true
                index: 50
              description:
                pattern: {type: String, value: 'This action represents the creation, validation and submission of the cancer report.'}
                index: 51
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                index: 52
              action:
                mustSupport: true
                array: true
                min: 3
                index: 53
                elements:
                  condition: {mustSupport: true, array: true, index: 54}
                  input: {mustSupport: true, array: true, index: 55}
                  output: {mustSupport: true, array: true, index: 56}
                  relatedAction: {mustSupport: true, array: true, index: 57}
                slicing:
                  rules: open
                  ordered: true
                  discriminator:
                  - {path: id, type: value}
                  min: 3
                  slices:
                    createCancerReport:
                      match: {id: create-cancer-report}
                      schema:
                        mustSupport: true
                        _required: true
                        index: 58
                        elements:
                          id:
                            pattern: {type: String, value: create-cancer-report}
                            mustSupport: true
                            index: 59
                          description:
                            pattern: {type: String, value: This action represents the creation of the cancer report.}
                            index: 60
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: create-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            index: 61
                        required: [id, code]
                    validateCancerReport:
                      match: {id: validate-cancer-report}
                      schema:
                        mustSupport: true
                        _required: true
                        index: 62
                        elements:
                          id:
                            pattern: {type: String, value: validate-cancer-report}
                            mustSupport: true
                            index: 63
                          description:
                            pattern: {type: String, value: This action represents the validation of the cancer report.}
                            index: 64
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: validate-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            index: 65
                        required: [id, code]
                    routeAndSendCancerReport:
                      match: {id: route-and-send-cancer-report}
                      schema:
                        short: Route and send cancer report
                        mustSupport: true
                        _required: true
                        index: 66
                        elements:
                          id:
                            pattern: {type: String, value: route-and-send-cancer-report}
                            mustSupport: true
                            index: 67
                          description:
                            short: Description of the route and send action.
                            pattern: {type: String, value: This action represents the routing and sending of the cancer report.}
                            mustSupport: true
                            index: 68
                          textEquivalent:
                            pattern: {type: String, value: Route and send cancer report}
                            mustSupport: true
                            index: 69
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: submit-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            index: 70
                        required: [textEquivalent, id, code, description]
            required: [id, code]
package_version: 2.0.0-ballot
class: profile
kind: resource
url: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition
base: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition
version: 2.0.0-ballot