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:
    mustSupport: true
    array: true
    min: 5
    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}
    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
                index: 4
              description:
                short: Starts the workflow
                pattern: {type: String, value: This action represents the start of the reporting workflow in response to the encounter-end event}
                mustSupport: true
                index: 5
              textEquivalent:
                short: Text equivalent of the start workflow action.
                pattern: {type: String, value: Start the reporting workflow in response to an encounter-end event}
                mustSupport: true
                index: 6
              code:
                short: Code for the "start" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 7
              trigger:
                short: When the "start" action should be triggered.
                mustSupport: true
                index: 8
                extensions:
                  namedEventType:
                    min: 0
                    isModifier: false
                    short: Indicates the types of named events to subscribe to from the HER.
                    index: 10
                    type: Extension
                    mustSupport: true
                    max: 1
                    url: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                elements:
                  extension:
                    isModifier: false
                    short: Additional content defined by implementations
                    type: Extension
                    array: true
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                    index: 9
                    slicing:
                      rules: open
                      description: Extensions are always sliced by (at least) url
                      discriminator:
                      - {path: url, type: value}
                      min: 0
                      slices:
                        namedEventType:
                          match: {url: null}
                          schema:
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the HER.
                            type: Extension
                            mustSupport: true
                            url: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                            index: 10
                          min: 0
                          max: 1
                  type:
                    pattern: {type: Code, value: named-event}
                    index: 11
                  name:
                    pattern: {type: String, value: encounter-end}
                    index: 12
              relatedAction:
                mustSupport: true
                index: 13
                elements:
                  actionId:
                    pattern: {type: Id, value: check-reportability}
                    index: 14
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 15
                  offsetDuration: {type: Duration, index: 16}
            required: [relatedAction, textEquivalent, id, trigger, code, description]
        executeReportingWorkflow:
          match: {id: check-reportability}
          schema:
            short: Execute Reporting Workflow
            mustSupport: true
            _required: true
            index: 17
            elements:
              id:
                pattern: {type: String, value: check-reportability}
                mustSupport: true
                index: 18
              description:
                short: Check for reportability conditions
                pattern: {type: String, value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions.}
                mustSupport: true
                index: 19
              code:
                short: Code for the "execute-reporting-workflow" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                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
                            index: 23
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 24
                          condition:
                            index: 25
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 26
                              expression:
                                mustSupport: true
                                index: 27
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    index: 28
                            required: [expression]
                          input:
                            mustSupport: true
                            index: 29
                            elements:
                              id: {mustSupport: true, index: 30}
                            required: [id]
                          relatedAction:
                            index: 31
                            elements:
                              actionId:
                                pattern: {type: Id, value: create-hcs-report}
                                index: 32
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 33
                        required: [id, code]
                    isInpatientEncounterReportable:
                      match: {id: is-inpatient-encounter-reportable}
                      schema:
                        type: BackboneElement
                        mustSupport: true
                        _required: true
                        index: 34
                        elements:
                          id:
                            pattern: {type: String, value: is-inpatient-encounter-reportable}
                            mustSupport: true
                            index: 35
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: evaluate-condition, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 36
                          condition:
                            index: 37
                            elements:
                              kind:
                                pattern: {type: Code, value: applicability}
                                index: 38
                              expression:
                                mustSupport: true
                                index: 39
                                elements:
                                  language:
                                    pattern: {type: Code, value: text/fhirpath}
                                    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-hcs-report}
                                index: 44
                              relationship:
                                pattern: {type: Code, value: before-start}
                                index: 45
                        required: [id, code]
            required: [id, code, description]
        createReport:
          match: {id: create-hcs-report}
          schema:
            _required: true
            index: 46
            elements:
              id:
                pattern: {type: String, value: create-hcs-report}
                mustSupport: true
                index: 47
              description:
                pattern: {type: String, value: 'This action represents the creation, validation and submission of the health care survey report.'}
                index: 48
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: create-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 49
              input:
                mustSupport: true
                index: 50
                elements:
                  id: {mustSupport: true, index: 51}
                required: [id]
              output:
                mustSupport: true
                index: 52
                elements:
                  id: {mustSupport: true, index: 53}
                required: [id]
              relatedAction:
                index: 54
                elements:
                  actionId:
                    pattern: {type: Id, value: validate-hcs-report}
                    index: 55
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 56
            required: [id, code]
        validateReport:
          match: {id: validate-hcs-report}
          schema:
            _required: true
            index: 57
            elements:
              id:
                pattern: {type: String, value: validate-hcs-report}
                mustSupport: true
                index: 58
              description:
                pattern: {type: String, value: This action represents the validation of the HCS 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
              input:
                mustSupport: true
                index: 61
                elements:
                  id: {mustSupport: true, index: 62}
                required: [id]
              output:
                mustSupport: true
                index: 63
                elements:
                  id: {mustSupport: true, index: 64}
                required: [id]
              relatedAction:
                index: 65
                elements:
                  actionId:
                    pattern: {type: Id, value: submit-hcs-report}
                    index: 66
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 67
            required: [id]
        submitHcsReport:
          match: {id: submit-hcs-report}
          schema:
            short: Route and send HCS Report
            _required: true
            index: 68
            elements:
              id:
                pattern: {type: String, value: submit-hcs-report}
                mustSupport: true
                index: 69
              description:
                short: Description of the route and send action.
                pattern: {type: String, value: This action represents the routing and sending of the HCS Report}
                mustSupport: true
                index: 70
              textEquivalent:
                pattern: {type: String, value: Route and send HCS Report}
                mustSupport: true
                index: 71
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: submit-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 72
              input:
                mustSupport: true
                index: 73
                elements:
                  id: {mustSupport: true, index: 74}
                required: [id]
            required: [textEquivalent, id, description]
package_version: 1.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition
base: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition
version: 1.0.0