description: 'This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by an eRSD specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. The final determination of reportability is made by the Public Health Agency or Agencies appropriate for the event, and may be performed by a combination of decisions occurring at various points during the processing of an eICR, as explained in the Reportability Response profile.'
package_name: hl7.fhir.us.ecr.r4b
derivation: constraint
name: ERSDPlanDefinition
type: PlanDefinition
elements:
  extension:
    mustSupport: true
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        variable:
          match: {url: null}
          schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/variable', index: 1}
          min: 0
  action:
    mustSupport: true
    array: true
    min: 5
    index: 2
    elements:
      code:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action'}
        mustSupport: true
        index: 3
      input:
        index: 4
        extensions:
          us-ph-fhirquerypattern-extension:
            url: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension
            type: Extension
            mustSupport: true
            index: 6
            elements:
              url:
                pattern: {type: Uri, value: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension'}
                mustSupport: true
                index: 7
            required: [url]
        elements:
          extension:
            mustSupport: true
            index: 5
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                us-ph-fhirquerypattern-extension:
                  match: {url: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension'}
                  schema:
                    type: Extension
                    mustSupport: true
                    url: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension
                    index: 6
                    elements:
                      url:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension'}
                        mustSupport: true
                        index: 7
                    required: [url]
      relatedAction:
        elements:
          offsetDuration: {mustSupport: true, index: 8}
    slicing:
      rules: open
      ordered: true
      discriminator:
      - {path: id, type: value}
      min: 5
      slices:
        encounterStart:
          match: {id: start-workflow}
          schema:
            short: Encounter start code
            mustSupport: true
            _required: true
            index: 9
            elements:
              id:
                pattern: {type: String, value: start-workflow}
                mustSupport: true
                index: 10
              description:
                short: Description of the "start" action.
                pattern: {type: String, value: This action represents the start of the reporting workflow in response to the encounter-start event.}
                mustSupport: true
                index: 11
              textEquivalent:
                short: Text equivalent of the "start" action.
                pattern: {type: String, value: Start the reporting workflow in response to an encounter-start event}
                mustSupport: true
                index: 12
              code:
                short: Code for the "start" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 13
              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, severity: error, expression: 'name.supersetOf(extension(''http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension'').value.coding.code)'}
                mustSupport: 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/ecr/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: 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/ecr/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}
                    index: 17
                  name:
                    pattern: {type: String, value: encounter-start}
                    index: 18
              relatedAction:
                mustSupport: true
                index: 19
                elements:
                  actionId:
                    pattern: {type: Id, value: check-suspected-disorder}
                    index: 20
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 21
                  offsetDuration: {type: Duration, index: 22}
            required: [relatedAction, textEquivalent, id, trigger, code, description]
        checkSuspectedDisorder:
          match: {id: check-suspected-disorder}
          schema:
            short: Check suspected disorder
            mustSupport: true
            _required: true
            index: 23
            elements:
              id:
                pattern: {type: String, value: check-suspected-disorder}
                mustSupport: true
                index: 24
              description:
                short: Description of the check for suspected disorders action.
                pattern: {type: String, value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.}
                mustSupport: true
                index: 25
              code:
                short: Code for the "check-suspected-disorder" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 26
              action:
                array: true
                min: 2
                index: 27
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 2
                  slices:
                    isEncounterSuspectedDisorder:
                      match: {id: is-encounter-suspected-disorder}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 28
                        elements:
                          id:
                            pattern: {type: String, value: is-encounter-suspected-disorder}
                            mustSupport: true
                            index: 29
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: check-trigger-codes, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                            index: 30
                          condition:
                            index: 31
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 32
                              expression:
                                mustSupport: true
                                index: 33
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 34
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 35
                            elements:
                              id: {mustSupport: true, index: 36}
                            required: [id]
                          relatedAction:
                            index: 37
                            elements:
                              actionId:
                                pattern: {type: Id, value: create-eicr}
                                index: 38
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 39
                        required: [id, code]
                    continueCheckReportable:
                      match: {id: continue-check-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 40
                        elements:
                          id:
                            pattern: {type: String, value: continue-check-reportable}
                            mustSupport: true
                            index: 41
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                            index: 42
                          condition:
                            index: 43
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 44
                              expression:
                                mustSupport: true
                                index: 45
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 46
                            required: [expression]
                          relatedAction:
                            index: 47
                            elements:
                              actionId:
                                pattern: {type: Id, value: check-reportable}
                                index: 48
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 49
                              offsetDuration: {type: Duration, index: 50}
                        required: [id, code]
            required: [id, code, description]
        checkReportable:
          match: {id: check-reportable}
          schema:
            short: Check the encounter for reportability
            _required: true
            index: 51
            elements:
              id:
                pattern: {type: String, value: check-reportable}
                mustSupport: true
                index: 52
              description:
                short: Description of the Periodic Update of eICR action.
                pattern: {type: String, value: This action represents the check for suspected reportability of the eICR.}
                index: 53
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 54
              action:
                array: true
                min: 3
                index: 55
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 3
                  slices:
                    isEncounterReportable:
                      match: {id: is-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 56
                        elements:
                          id:
                            pattern: {type: String, value: is-encounter-reportable}
                            mustSupport: true
                            index: 57
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: check-trigger-codes, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                            index: 58
                          condition:
                            index: 59
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 60
                              expression:
                                mustSupport: true
                                index: 61
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 62
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 63
                            elements:
                              id: {mustSupport: true, index: 64}
                            required: [id]
                          relatedAction:
                            index: 65
                            elements:
                              actionId:
                                pattern: {type: Id, value: create-eicr}
                                index: 66
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 67
                        required: [id, code]
                    checkUpdateEicr:
                      match: {id: check-update-eicr}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 68
                        elements:
                          id:
                            pattern: {type: String, value: check-update-eicr}
                            mustSupport: true
                            index: 69
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                            index: 70
                          condition:
                            index: 71
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 72
                              expression:
                                mustSupport: true
                                index: 73
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 74
                            required: [expression]
                          relatedAction:
                            index: 75
                            elements:
                              actionId:
                                pattern: {type: Id, value: create-eicr}
                                index: 76
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 77
                        required: [id, code]
                    encounterInProgress:
                      match: {id: is-encounter-in-progress}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 78
                        elements:
                          id:
                            pattern: {type: String, value: is-encounter-in-progress}
                            mustSupport: true
                            index: 79
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                            index: 80
                          condition:
                            index: 81
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 82
                              expression:
                                mustSupport: true
                                index: 83
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 84
                            required: [expression]
                          relatedAction:
                            index: 85
                            elements:
                              actionId:
                                pattern: {type: Id, value: check-reportable}
                                index: 86
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 87
                              offsetDuration: {type: Duration, index: 88}
                        required: [id, code]
            required: [id, code]
        createEicr:
          match: {id: create-eicr}
          schema:
            short: Create the eICR
            _required: true
            index: 89
            elements:
              id:
                pattern: {type: String, value: create-eicr}
                mustSupport: true
                index: 90
              description:
                pattern: {type: String, value: This action represents the creation of the eICR. It subsequently calls validate.}
                index: 91
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: create-report, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 92
              relatedAction:
                mustSupport: true
                index: 93
                elements:
                  actionId:
                    pattern: {type: Id, value: validate-eicr}
                    index: 94
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 95
            required: [relatedAction, id]
        validateEicr:
          match: {id: validate-eicr}
          schema:
            short: Validate the eICR
            _required: true
            index: 96
            elements:
              id:
                pattern: {type: String, value: validate-eicr}
                mustSupport: true
                index: 97
              description:
                pattern: {type: String, value: This action represents the validation of the eICR. It subsequently calls route-and-send.}
                index: 98
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: validate-report, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 99
              relatedAction:
                mustSupport: true
                index: 100
                elements:
                  actionId:
                    pattern: {type: Id, value: route-and-send-eicr}
                    index: 101
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 102
            required: [relatedAction, id]
        routeAndSendEicr:
          match: {id: route-and-send-eicr}
          schema:
            short: Route and send eICR
            _required: true
            index: 103
            elements:
              id:
                pattern: {type: String, value: route-and-send-eicr}
                mustSupport: true
                index: 104
              description:
                short: Description of the route and send action.
                pattern: {type: String, value: This action represents the routing and sending of the eICR.}
                mustSupport: true
                index: 105
              textEquivalent:
                pattern: {type: String, value: Route and send eICR}
                mustSupport: true
                index: 106
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: submit-report, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 107
            required: [textEquivalent, id, description]
        encounterModified:
          match: {id: encounter-modified}
          schema:
            short: Encounter modified code
            mustSupport: true
            _required: true
            index: 108
            elements:
              id:
                pattern: {type: String, value: encounter-modified}
                mustSupport: true
                index: 109
              description:
                short: Description of the "encounter-modified" action.
                pattern: {type: String, value: This action represents the start of the reporting workflow in response to the encounter-modified event}
                mustSupport: true
                index: 110
              textEquivalent:
                short: Text equivalent of the "encounter-modified" action.
                pattern: {type: String, value: Start the reporting workflow in response to an encounter-modified event}
                mustSupport: true
                index: 111
              code:
                short: Code for the "encounter-modified" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions'}
                index: 112
              trigger:
                short: When the "encounter-modified" action should be triggered.
                constraint:
                  epd-1: {human: The code value of the namedEventType SHALL be the same as the name element, severity: error, expression: 'name.supersetOf(extension(''http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension'').value.coding.code)'}
                mustSupport: true
                index: 113
                extensions:
                  namedEventType:
                    min: 0
                    isModifier: false
                    short: Indicates the types of named events to subscribe to from the EHR.
                    index: 115
                    type: Extension
                    mustSupport: true
                    max: 1
                    url: http://hl7.org/fhir/us/ecr/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: 114
                    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/ecr/StructureDefinition/us-ph-named-eventtype-extension
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                            index: 115
                          min: 0
                          max: 1
                  type:
                    pattern: {type: Code, value: named-event}
                    index: 116
                  name:
                    pattern: {type: String, value: encounter-modified}
                    index: 117
              condition:
                index: 118
                elements:
                  kind:
                    pattern: {type: Code, value: applicability}
                    index: 119
                  expression:
                    mustSupport: true
                    index: 120
                    elements:
                      language:
                        pattern: {type: Code, value: text/fhirpath}
                        index: 121
                required: [expression]
              relatedAction:
                mustSupport: true
                index: 122
                elements:
                  actionId:
                    pattern: {type: Id, value: create-eicr}
                    index: 123
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 124
            required: [relatedAction, textEquivalent, id, trigger, code, description]
package_version: 2.1.1
extensions:
  variable: {url: 'http://hl7.org/fhir/StructureDefinition/variable', min: 0, type: Extension, mustSupport: true, index: 1}
class: profile
kind: resource
url: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition
base: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition
version: 2.1.1