description: 'This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to a cancer registry, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the cancer condition is reportable, gives timing information, next steps and condition information to the clinician. 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
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/medmorph/ValueSet/us-ph-plandefinition-action'}
        mustSupport: true
        index: 1
      input:
        index: 2
        extensions:
          us-ph-fhirquerypattern-extension:
            url: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
            type: Extension
            mustSupport: true
            index: 4
            elements:
              url:
                pattern: {type: Uri, value: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                mustSupport: true
                index: 5
            required: [url]
        elements:
          extension:
            mustSupport: true
            index: 3
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                us-ph-fhirquerypattern-extension:
                  match: {url: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                  schema:
                    type: Extension
                    mustSupport: true
                    index: 4
                    elements:
                      url:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                        mustSupport: true
                        index: 5
                    required: [url]
    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: 6
            elements:
              id:
                pattern: {type: String, value: start-workflow}
                mustSupport: true
                index: 7
              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: 8
              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: 9
              code:
                short: Code for the "start" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 10
              trigger:
                short: When the "start" action should be triggered.
                constraint:
                  epd-1: {human: The code value of the namedEventType SHALL be the same as the name element, source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: 'extension(''http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType'').value.coding.code.supersetOf(name)'}
                mustSupport: true
                index: 11
                extensions:
                  namedEventType:
                    constraint:
                      ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                      ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                    min: 0
                    isModifier: false
                    short: Indicates the types of named events to subscribe to from the HER.
                    index: 13
                    type: Extension
                    mustSupport: true
                    max: 1
                    url: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                elements:
                  extension:
                    constraint:
                      ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                      ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                    isModifier: false
                    short: Additional content defined by implementations
                    index: 12
                    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:
                            constraint:
                              ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                              ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the HER.
                            index: 13
                            type: Extension
                            mustSupport: true
                            url: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                          min: 0
                          max: 1
                    type: Extension
                    array: true
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                  type:
                    pattern: {type: Code, value: named-event}
                    index: 14
                  name:
                    pattern: {type: String, value: encounter-close}
                    index: 15
              relatedAction:
                mustSupport: true
                index: 16
                elements:
                  actionId:
                    pattern: {type: Id, value: check-reportable}
                    index: 17
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 18
                  offsetDuration: {type: Duration, index: 19}
            required: [relatedAction, textEquivalent, id, trigger, code, description]
        checkReportable:
          match: {id: check-reportable}
          schema:
            _required: true
            index: 20
            elements:
              id:
                pattern: {type: String, value: check-reportable}
                mustSupport: true
                index: 21
              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: 22
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 23
              action:
                index: 24
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 1
                  slices:
                    isEncounterReportable:
                      match: {id: is-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 25
                        elements:
                          id:
                            pattern: {type: String, value: is-encounter-reportable}
                            mustSupport: true
                            index: 26
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: check-trigger-codes, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 27
                          condition:
                            index: 28
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 29
                              expression:
                                mustSupport: true
                                index: 30
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 31
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 32
                            elements:
                              id: {mustSupport: true, index: 33}
                            required: [id]
                          relatedAction:
                            index: 34
                            elements:
                              actionId:
                                pattern: {type: Id, value: report-cancer-data}
                                index: 35
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 36
                        required: [id, code]
                    shouldContinueReporting:
                      match: {id: should-continue-reporting}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 37
                        elements:
                          id:
                            pattern: {type: String, value: should-continue-reporting}
                            mustSupport: true
                            index: 38
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 39
                          condition:
                            index: 40
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 41
                              expression:
                                mustSupport: true
                                index: 42
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 43
                            required: [expression]
                          relatedAction:
                            index: 44
                            elements:
                              actionId:
                                pattern: {type: Id, value: check-reportable}
                                index: 45
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 46
                              offsetDuration: {type: Duration, index: 47}
                        required: [id, code]
            required: [id, action, code]
        reportCancerData:
          match: {id: report-cancer-data}
          schema:
            index: 48
            elements:
              id:
                pattern: {type: String, value: report-cancer-data}
                mustSupport: true
                index: 49
              description:
                pattern: {type: String, value: 'This action represents the creation, validation and submission of the cancer report.'}
                index: 50
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 51
              action:
                mustSupport: true
                array: true
                min: 3
                index: 52
                slicing:
                  rules: open
                  ordered: true
                  discriminator:
                  - {path: id, type: value}
                  min: 3
                  slices:
                    createCancerReport:
                      match: {id: create-cancer-report}
                      schema:
                        _required: true
                        index: 53
                        elements:
                          id:
                            pattern: {type: String, value: create-cancer-report}
                            mustSupport: true
                            index: 54
                          description:
                            pattern: {type: String, value: This action represents the creation of the cancer report.}
                            index: 55
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: create-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 56
                        required: [id]
                    validateCancerReport:
                      match: {id: validate-cancer-report}
                      schema:
                        _required: true
                        index: 57
                        elements:
                          id:
                            pattern: {type: String, value: validate-cancer-report}
                            mustSupport: true
                            index: 58
                          description:
                            pattern: {type: String, value: This action represents the validation of the cancer report.}
                            index: 59
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: validate-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 60
                        required: [id]
                    routeAndSendCancerReport:
                      match: {id: route-and-send-cancer-report}
                      schema:
                        short: Route and send cancer report
                        _required: true
                        index: 61
                        elements:
                          id:
                            pattern: {type: String, value: route-and-send-cancer-report}
                            mustSupport: true
                            index: 62
                          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: 63
                          textEquivalent:
                            pattern: {type: String, value: Route and send cancer report}
                            mustSupport: true
                            index: 64
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: submit-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 65
                        required: [textEquivalent, id, description]
            required: [id, code]
package_version: cancer-registry-reporting-0.1.0
class: profile
kind: resource
url: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition
base: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition
version: 0.1.0