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
derivation: constraint
name: HCSPlanDefinition
type: PlanDefinition
elements:
  action:
    mustSupport: true
    array: true
    min: 2
    index: 0
    elements:
      code:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action'}
        mustSupport: true
        index: 1
      input:
        index: 2
        extensions:
          us-ph-fhirquerypattern-extension:
            url: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
            type: Extension
            mustSupport: true
            index: 4
            elements:
              url:
                pattern: {type: Uri, value: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                mustSupport: true
                index: 5
            required: [url]
        elements:
          extension:
            mustSupport: true
            index: 3
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: null
              slices:
                us-ph-fhirquerypattern-extension:
                  match: {url: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                  schema:
                    type: Extension
                    mustSupport: true
                    index: 4
                    elements:
                      url:
                        pattern: {type: Uri, value: 'http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension'}
                        mustSupport: true
                        index: 5
                    required: [url]
    slicing:
      rules: open
      ordered: true
      discriminator:
      - {path: id, type: value}
      min: 2
      slices:
        encounterClose:
          match: {id: start-workflow}
          schema:
            short: Encounter Close Action
            mustSupport: true
            _required: true
            index: 6
            elements:
              id:
                pattern: {type: String, value: start-workflow}
                mustSupport: true
                index: 7
              description:
                short: Starts the workflow
                pattern: {type: String, value: This action represents the start of the reporting workflow in response to the encounter-close event}
                mustSupport: true
                index: 8
              textEquivalent:
                short: Text equivalent of the start workflow action.
                pattern: {type: String, value: Start the reporting workflow in response to an encounter-close event}
                mustSupport: true
                index: 9
              code:
                short: Code for the "start" action.
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: initiate-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 10
              trigger:
                short: When the "start" action should be triggered.
                constraint:
                  epd-1: {human: The code value of the namedEventType SHALL be the same as the name element, source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: 'extension(''http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType'').value.coding.code.supersetOf(name)'}
                mustSupport: true
                index: 11
                extensions:
                  namedEventType:
                    constraint:
                      ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                      ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                    min: 0
                    isModifier: false
                    short: Indicates the types of named events to subscribe to from the HER.
                    index: 13
                    type: Extension
                    mustSupport: true
                    max: 1
                    url: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                elements:
                  extension:
                    constraint:
                      ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                      ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                    isModifier: false
                    short: Additional content defined by implementations
                    index: 12
                    slicing:
                      rules: open
                      description: Extensions are always sliced by (at least) url
                      discriminator:
                      - {path: url, type: value}
                      min: 0
                      slices:
                        namedEventType:
                          match: {url: null}
                          schema:
                            constraint:
                              ele-1: {human: All FHIR elements must have a @value or children, source: 'http://hl7.org/fhir/StructureDefinition/Element', severity: error, expression: hasValue() or (children().count() > id.count())}
                              ext-1: {human: 'Must have either extensions or value[x], not both', source: 'http://hl7.org/fhir/StructureDefinition/Extension', severity: error, expression: extension.exists() != value.exists()}
                            isModifier: false
                            short: Indicates the types of named events to subscribe to from the HER.
                            index: 13
                            type: Extension
                            mustSupport: true
                            url: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType
                            base: {max: '*', min: 0, path: Element.extension}
                            isSummary: false
                          min: 0
                          max: 1
                    type: Extension
                    array: true
                    base: {max: '*', min: 0, path: Element.extension}
                    isSummary: false
                  type:
                    pattern: {type: Code, value: named-event}
                    index: 14
                  name:
                    pattern: {type: String, value: encounter-close}
                    index: 15
              relatedAction:
                mustSupport: true
                index: 16
                elements:
                  actionId:
                    pattern: {type: Id, value: check-survey-participants}
                    index: 17
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 18
                  offsetDuration: {type: Duration, index: 19}
            required: [relatedAction, textEquivalent, id, trigger, code, description]
        checkParticipants:
          match: {id: check-survey-participants}
          schema:
            _required: true
            index: 20
            elements:
              id:
                pattern: {type: String, value: check-survey-participants}
                mustSupport: true
                index: 21
              description:
                short: Check if a Practitioner is registered for a survey.
                pattern: {type: String, value: This action represents the check if Practitioner is registered to report on health care surveys.}
                index: 22
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: check-participant-registration, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 23
              relatedAction:
                mustSupport: true
                index: 24
                elements:
                  actionId:
                    pattern: {type: Id, value: report-to-nchs}
                    index: 25
                  relationship:
                    pattern: {type: Code, value: before-start}
                    index: 26
            required: [relatedAction, id, code]
        reportToNchs:
          match: {id: report-to-nchs}
          schema:
            _required: true
            index: 27
            elements:
              id:
                pattern: {type: String, value: report-to-nchs}
                mustSupport: true
                index: 28
              description:
                pattern: {type: String, value: 'This action represents the creation, validation and submission of the health care survey report.'}
                index: 29
              code:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: execute-reporting-workflow, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                index: 30
              action:
                mustSupport: true
                array: true
                min: 3
                index: 31
                slicing:
                  rules: open
                  ordered: true
                  discriminator:
                  - {path: id, type: value}
                  min: 3
                  slices:
                    createReport:
                      match: {id: create-hcs-report}
                      schema:
                        _required: true
                        index: 32
                        elements:
                          id:
                            pattern: {type: String, value: create-hcs-report}
                            mustSupport: true
                            index: 33
                          description:
                            pattern: {type: String, value: This action represents the creation of the HCS Report.}
                            index: 34
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: create-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 35
                        required: [id]
                    validateReport:
                      match: {id: validate-hcs-report}
                      schema:
                        _required: true
                        index: 36
                        elements:
                          id:
                            pattern: {type: String, value: validate-hcs-report}
                            mustSupport: true
                            index: 37
                          description:
                            pattern: {type: String, value: This action represents the validation of the HCS Report}
                            index: 38
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: validate-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 39
                        required: [id]
                    routeAndSendHcsReport:
                      match: {id: route-and-send-hcs-report}
                      schema:
                        short: Route and send HCS Report
                        _required: true
                        index: 40
                        elements:
                          id:
                            pattern: {type: String, value: route-and-send-hcs-report}
                            mustSupport: true
                            index: 41
                          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: 42
                          textEquivalent:
                            pattern: {type: String, value: Route and send HCS Report}
                            mustSupport: true
                            index: 43
                          code:
                            pattern:
                              type: CodeableConcept
                              value:
                                coding:
                                - {code: submit-report, system: 'http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions'}
                            index: 44
                        required: [textEquivalent, id, description]
            required: [id, code]
package_version: care-surveys-reporting-0.1.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: 0.1.0