description: 'This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).'
package_name: hl7.fhir.us.health-care-surveys-reporting
derivation: constraint
name: HCSPlanDefinition
type: PlanDefinition
elements:
  action:
    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'}
        index: 1
    slicing:
      rules: open
      ordered: true
      discriminator:
      - {path: id, type: value}
      min: 5
      slices:
        startWorkflow:
          match: {id: start-workflow}
          schema:
            _required: true
            index: 2
            elements:
              id:
                pattern: {type: string, value: start-workflow}
                type: string
                index: 3
              description:
                pattern: {type: string, value: Start the workflow action.}
                type: string
                index: 4
              textEquivalent:
                short: Text equivalent of the start workflow action.
                pattern: {type: string, value: Start the reporting workflow in response to an encounter-end event}
                mustSupport: true
                type: string
                index: 5
              code:
                short: Code for the start action.
                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: 6
              trigger:
                short: When the start action should be triggered.
                index: 7
                extensions:
                  namedEventType: {url: null, short: Indicates the types of named events to subscribe to from the EHR., index: 8}
                elements:
                  extension:
                    short: Indicates the types of named events to subscribe to from the EHR.
                    index: 8
                    slicing:
                      slices:
                        namedEventType:
                          match: {}
                          schema: {short: Indicates the types of named events to subscribe to from the EHR., index: 8}
                  name:
                    pattern: {type: string, value: encounter-end}
                    type: string
                    index: 9
              relatedAction:
                index: 10
                elements:
                  actionId:
                    pattern: {type: id, value: check-reportability}
                    type: id
                    index: 11
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 12
                  offset:
                    choices: [offsetDuration]
                    index: 14
                    slicing:
                      slices:
                        offsetDuration:
                          match: {}
                          schema:
                            choices: [offsetDuration]
                            index: 14
                  offsetDuration:
                    type: Duration
                    choiceOf: offset
                    index: 15
                    slicing:
                      slices:
                        offsetDuration:
                          match: {}
                          schema: {type: Duration, choiceOf: offset, index: 15}
            required: [code, id, relatedAction, textEquivalent, trigger]
        executeReportingWorkflow:
          match: {id: check-reportability}
          schema:
            _required: true
            index: 16
            elements:
              id:
                pattern: {type: string, value: check-reportability}
                type: string
                index: 17
              description:
                pattern: {type: string, value: Execute reporting workflow action.}
                type: string
                index: 18
              code:
                short: Code for the execute-reporting-workflow action.
                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: 19
              trigger:
                extensions:
                  namedEventType: {url: null, index: 20}
                elements:
                  extension:
                    index: 20
                    slicing:
                      slices:
                        namedEventType:
                          match: {}
                          schema: {index: 20}
              action:
                array: true
                min: 2
                index: 21
                slicing:
                  rules: open
                  discriminator:
                  - {path: id, type: value}
                  min: 2
                  slices:
                    isAmbulatoryEncounterReportable:
                      match: {id: is-ambulatory-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 22
                        elements:
                          id:
                            pattern: {type: string, value: is-ambulatory-encounter-reportable}
                            mustSupport: true
                            type: string
                            index: 23
                          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: 24
                          condition:
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 25
                              expression:
                                mustSupport: true
                                index: 26
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 27
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 28
                            elements:
                              id: {mustSupport: true, index: 29}
                            required: [id]
                          relatedAction:
                            elements:
                              actionId:
                                pattern: {type: id, value: create-hcs-report}
                                type: id
                                index: 30
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 31
                        required: [code, id]
                    isInpatientEncounterReportable:
                      match: {id: is-inpatient-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 32
                        elements:
                          id:
                            pattern: {type: string, value: is-inpatient-encounter-reportable}
                            mustSupport: true
                            type: string
                            index: 33
                          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: 34
                          condition:
                            elements:
                              kind:
                                pattern: {type: code, value: applicability}
                                type: code
                                index: 35
                              expression:
                                mustSupport: true
                                index: 36
                                elements:
                                  language:
                                    pattern: {type: code, value: text/fhirpath}
                                    type: code
                                    index: 37
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 38
                            elements:
                              id: {mustSupport: true, index: 39}
                            required: [id]
                          relatedAction:
                            elements:
                              actionId:
                                pattern: {type: id, value: create-hcs-report}
                                type: id
                                index: 40
                              relationship:
                                pattern: {type: code, value: before-start}
                                type: code
                                index: 41
                        required: [code, id]
            required: [code, id]
        createReport:
          match: {id: create-hcs-report}
          schema:
            _required: true
            index: 42
            elements:
              id:
                pattern: {type: string, value: create-hcs-report}
                type: string
                index: 43
              description:
                pattern: {type: string, value: Create HCS report action.}
                type: string
                index: 44
              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: 45
              trigger:
                extensions:
                  namedEventType: {url: null, index: 46}
                elements:
                  extension:
                    index: 46
                    slicing:
                      slices:
                        namedEventType:
                          match: {}
                          schema: {index: 46}
              input:
                index: 47
                elements:
                  id: {mustSupport: true, index: 48}
                required: [id]
              output:
                index: 49
                elements:
                  id: {mustSupport: true, index: 50}
                required: [id]
              relatedAction:
                elements:
                  actionId:
                    pattern: {type: id, value: validate-hcs-report}
                    type: id
                    index: 51
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 52
            required: [code, id]
        validateReport:
          match: {id: validate-hcs-report}
          schema:
            _required: true
            index: 53
            elements:
              id:
                pattern: {type: string, value: validate-hcs-report}
                type: string
                index: 54
              description:
                pattern: {type: string, value: Validate HCS report action.}
                type: string
                index: 55
              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: 56
              trigger:
                extensions:
                  namedEventType: {url: null, index: 57}
                elements:
                  extension:
                    index: 57
                    slicing:
                      slices:
                        namedEventType:
                          match: {}
                          schema: {index: 57}
              input:
                index: 58
                elements:
                  id: {mustSupport: true, index: 59}
                required: [id]
              output:
                index: 60
                elements:
                  id: {mustSupport: true, index: 61}
                required: [id]
              relatedAction:
                elements:
                  actionId:
                    pattern: {type: id, value: submit-hcs-report}
                    type: id
                    index: 62
                  relationship:
                    pattern: {type: code, value: before-start}
                    type: code
                    index: 63
            required: [id]
        submitHcsReport:
          match: {id: submit-hcs-report}
          schema:
            _required: true
            index: 64
            elements:
              id:
                pattern: {type: string, value: submit-hcs-report}
                type: string
                index: 65
              description:
                pattern: {type: string, value: Submit HCS report action.}
                type: string
                index: 66
              textEquivalent:
                pattern: {type: string, value: Route and send HCS Report}
                mustSupport: true
                type: string
                index: 67
              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: 68
              trigger:
                extensions:
                  namedEventType: {url: null, index: 69}
                elements:
                  extension:
                    index: 69
                    slicing:
                      slices:
                        namedEventType:
                          match: {}
                          schema: {index: 69}
              input:
                index: 70
                elements:
                  id: {mustSupport: true, index: 71}
                required: [id]
            required: [id, textEquivalent]
package_version: 2.0.0-ballot
class: profile
kind: resource
url: http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition
base: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition
version: 2.0.0-ballot