description: 'This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to RESP-NET.'
package_name: hl7.fhir.us.resp-net
derivation: constraint
name: RESPNETPlanDefinition
type: PlanDefinition
elements:
  action:
    mustSupport: true
    array: true
    min: 5
    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: 5
      slices:
        startWorkflow:
          match: {id: start-workflow}
          schema:
            short: Start Workflow Action
            mustSupport: true
            _required: true
            index: 3
            elements:
              id:
                pattern: {type: string, value: start-workflow}
                mustSupport: true
                type: string
                index: 4
              description:
                short: Starts the workflow
                pattern: {type: string, value: This action represents the start of the reporting workflow in response to a named event}
                mustSupport: true
                type: string
                index: 5
              textEquivalent:
                short: Text equivalent of the start workflow action.
                pattern: {type: string, value: Start the reporting workflow in response to a named event}
                mustSupport: true
                type: string
                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'}
                type: CodeableConcept
                index: 7
              trigger:
                short: Trigger Events defined by implementations
                array: true
                min: 2
                index: 8
                slicing:
                  rules: open
                  description: Triggers can be slided by the named events
                  discriminator:
                  - {path: name, type: value}
                  min: 2
                  slices:
                    encounterClose:
                      match: {name: encounter-close}
                      schema:
                        short: Encounter Close Trigger
                        mustSupport: true
                        _required: true
                        index: 9
                        extensions:
                          namedEventType:
                            min: 0
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the EHR.
                            index: 11
                            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
                            type: Extension
                            array: true
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                            index: 10
                            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: 11
                                  min: 0
                                  max: 1
                          type:
                            pattern: {type: code, value: named-event}
                            type: code
                            index: 12
                          name:
                            pattern: {type: string, value: encounter-close}
                            type: string
                            index: 13
                    encounterStart:
                      match: {name: encounter-start}
                      schema:
                        short: Encounter Start Trigger
                        mustSupport: true
                        _required: true
                        index: 14
                        extensions:
                          namedEventType:
                            min: 0
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the EHR.
                            index: 16
                            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
                            type: Extension
                            array: true
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                            index: 15
                            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: 16
                                  min: 0
                                  max: 1
                          type:
                            pattern: {type: code, value: named-event}
                            type: code
                            index: 17
                          name:
                            pattern: {type: string, value: encounter-start}
                            type: string
                            index: 18
              input:
                mustSupport: true
                array: true
                min: 1
                index: 19
                elements:
                  id: {mustSupport: true, index: 20}
                required: [id]
              relatedAction:
                mustSupport: true
                index: 21
                elements:
                  actionId:
                    pattern: {type: id, value: check-reportability}
                    type: id
                    index: 22
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 23
                  offsetDuration: {type: Duration, index: 24}
            required: [code, description, id, input, relatedAction, textEquivalent]
        checkReportabilityWorkflow:
          match: {id: check-reportability}
          schema:
            short: Check Reportability Workflow
            mustSupport: true
            _required: true
            index: 25
            elements:
              id:
                pattern: {type: string, value: check-reportability}
                mustSupport: true
                type: string
                index: 26
              description:
                short: Check for reportability conditions and labresults
                pattern: {type: string, value: This action represents the start of the check for reportable conditions and labresults in response to the named event.}
                mustSupport: true
                type: string
                index: 27
              code:
                short: Code for the "check-reportability" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                type: CodeableConcept
                index: 28
              action:
                array: true
                min: 7
                index: 29
                elements:
                  condition: {mustSupport: true, array: true, index: 30}
                  input: {mustSupport: true, array: true, index: 31}
                  output: {mustSupport: true, array: true, index: 32}
                  relatedAction: {mustSupport: true, array: true, index: 33}
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 7
                  slices:
                    isHospitalBasedInfluenzaCase:
                      match: {id: is-hospital-based-influenza-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 34
                        elements:
                          id:
                            pattern: {type: string, value: is-hospital-based-influenza-case}
                            mustSupport: true
                            type: string
                            index: 35
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 36
                          condition:
                            index: 37
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 38
                              expression:
                                mustSupport: true
                                index: 39
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 40
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 41
                            elements:
                              id: {mustSupport: true, index: 42}
                            required: [id]
                          relatedAction:
                            index: 43
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 44
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 45
                        required: [code, id, input]
                    isClinicalInfluenzaSurveillanceCase:
                      match: {id: is-clinical-surveillance-influena-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 46
                        elements:
                          id:
                            pattern: {type: string, value: is-clinical-surveillance-influena-case}
                            mustSupport: true
                            type: string
                            index: 47
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 48
                          condition:
                            index: 49
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 50
                              expression:
                                mustSupport: true
                                index: 51
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 52
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 53
                            elements:
                              id: {mustSupport: true, index: 54}
                            required: [id]
                          relatedAction:
                            index: 55
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 56
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 57
                        required: [code, id, input]
                    isHospitalDiseaseBurdenCase:
                      match: {id: is-hospital-disease-burden-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 58
                        elements:
                          id:
                            pattern: {type: string, value: is-hospital-disease-burden-case}
                            mustSupport: true
                            type: string
                            index: 59
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 60
                          condition:
                            index: 61
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 62
                              expression:
                                mustSupport: true
                                index: 63
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 64
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 65
                            elements:
                              id: {mustSupport: true, index: 66}
                            required: [id]
                          relatedAction:
                            index: 67
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 68
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 69
                        required: [code, id, input]
                    isCovid19SurveillanceCase:
                      match: {id: is-covid19-surveillance-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 70
                        elements:
                          id:
                            pattern: {type: string, value: is-covid19-surveillance-case}
                            mustSupport: true
                            type: string
                            index: 71
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 72
                          condition:
                            index: 73
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 74
                              expression:
                                mustSupport: true
                                index: 75
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 76
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 77
                            elements:
                              id: {mustSupport: true, index: 78}
                            required: [id]
                          relatedAction:
                            index: 79
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 80
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 81
                        required: [code, id, input]
                    isRsvSurveillanceCase:
                      match: {id: is-rsv-surveillance-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 82
                        elements:
                          id:
                            pattern: {type: string, value: is-rsv-surveillance-case}
                            mustSupport: true
                            type: string
                            index: 83
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 84
                          condition:
                            index: 85
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 86
                              expression:
                                mustSupport: true
                                index: 87
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 88
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 89
                            elements:
                              id: {mustSupport: true, index: 90}
                            required: [id]
                          relatedAction:
                            index: 91
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 92
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 93
                        required: [code, id, input]
                    isInfluenzaEffectivenessEvaluationCase:
                      match: {id: is-influenza-effectiveness-evaluation-case}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 94
                        elements:
                          id:
                            pattern: {type: string, value: is-influenza-effectiveness-evaluation-case}
                            mustSupport: true
                            type: string
                            index: 95
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 96
                          condition:
                            index: 97
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 98
                              expression:
                                mustSupport: true
                                index: 99
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 100
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 101
                            elements:
                              id: {mustSupport: true, index: 102}
                            required: [id]
                          relatedAction:
                            index: 103
                            elements:
                              actionId:
                                pattern: {type: id, value: create-resp-net-report}
                                type: id
                                index: 104
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 105
                        required: [code, id, input]
                    continueToCheckReportability:
                      match: {id: continue-to-check-reportability}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 106
                        elements:
                          id:
                            pattern: {type: string, value: continue-to-check-reportability}
                            mustSupport: true
                            type: string
                            index: 107
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                            type: CodeableConcept
                            index: 108
                          condition:
                            index: 109
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 110
                              expression:
                                mustSupport: true
                                index: 111
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 112
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 113
                            elements:
                              id: {mustSupport: true, index: 114}
                            required: [id]
                          relatedAction:
                            index: 115
                            elements:
                              actionId:
                                pattern: {type: id, value: check-reportability}
                                type: id
                                index: 116
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 117
                              offsetDuration: {type: Duration, index: 118}
                        required: [code, id, input]
            required: [code, description, id]
        createReport:
          match: {id: create-resp-net-report}
          schema:
            _required: true
            index: 119
            elements:
              id:
                pattern: {type: string, value: create-resp-net-report}
                mustSupport: true
                type: string
                index: 120
              description:
                pattern: {type: string, value: 'This action represents the creation, validation and submission of the RESP-NET report.'}
                type: string
                index: 121
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: create-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                type: CodeableConcept
                index: 122
              input:
                mustSupport: true
                index: 123
                elements:
                  id: {mustSupport: true, index: 124}
                required: [id]
              output:
                mustSupport: true
                index: 125
                elements:
                  id: {mustSupport: true, index: 126}
                required: [id]
              relatedAction:
                index: 127
                elements:
                  actionId:
                    pattern: {type: id, value: validate-resp-net-report}
                    type: id
                    index: 128
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 129
            required: [code, id]
        validateReport:
          match: {id: validate-resp-net-report}
          schema:
            _required: true
            index: 130
            elements:
              id:
                pattern: {type: string, value: validate-resp-net-report}
                mustSupport: true
                type: string
                index: 131
              description:
                pattern: {type: string, value: This action represents the validation of the RESP-NET Report}
                type: string
                index: 132
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: validate-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                type: CodeableConcept
                index: 133
              input:
                mustSupport: true
                index: 134
                elements:
                  id: {mustSupport: true, index: 135}
                required: [id]
              output:
                mustSupport: true
                index: 136
                elements:
                  id: {mustSupport: true, index: 137}
                required: [id]
              relatedAction:
                index: 138
                elements:
                  actionId:
                    pattern: {type: id, value: submit-resp-net-report}
                    type: id
                    index: 139
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 140
            required: [id]
        submitReport:
          match: {id: submit-resp-net-report}
          schema:
            short: Route and send RESP-NET Report
            _required: true
            index: 141
            elements:
              id:
                pattern: {type: string, value: submit-resp-net-report}
                mustSupport: true
                type: string
                index: 142
              description:
                short: Description of the route and send action.
                pattern: {type: string, value: This action represents the routing and sending of the RESP-NET Report}
                mustSupport: true
                type: string
                index: 143
              textEquivalent:
                pattern: {type: string, value: Route and send RESP-NET Report}
                mustSupport: true
                type: string
                index: 144
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: submit-report, system: 'http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions'}
                type: CodeableConcept
                index: 145
              input:
                mustSupport: true
                index: 146
                elements:
                  id: {mustSupport: true, index: 147}
                required: [id]
            required: [description, id, textEquivalent]
package_version: 1.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/us/resp-net/StructureDefinition/respnet-plandefinition
base: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition
version: 1.0.0