Module: HQMF2::DocumentUtilities

Included in:
Document
Defined in:
lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb

Overview

Utilities used by the document parser to handle generic tasks

Instance Method Summary collapse

Instance Method Details

#complex_coverage(data_criteria, check_criteria) ⇒ Object

Check elements that do not already exist; else, if they do, check if those elements are the same in a different, potentially matching, data criteria



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 107

def complex_coverage(data_criteria, check_criteria)
  same_value = data_criteria.value.nil? ||
               data_criteria.value.try(:to_model).try(:to_json) == check_criteria.value.try(:to_model).try(:to_json)

  same_field_values = same_field_values_check(data_criteria, check_criteria)

  same_negation_values = data_criteria.negation_code_list_id.nil? ||
                         data_criteria.negation_code_list_id == check_criteria.negation_code_list_id

  same_value && same_negation_values && same_field_values
end

#criteria_covered_by_criteria?(dc) ⇒ Boolean

Checks if one data criteria is covered by another (has all the appropriate elements of)

Returns:

  • (Boolean) 


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 65

def criteria_covered_by_criteria?(dc)
  @reference_ids.uniq

  base_criteria_defs = %w(patient_characteristic_ethnicity patient_characteristic_gender patient_characteristic_payer patient_characteristic_race)
  to_reject = true
  # don't reject if anything refers directly to this criteria
  to_reject &&= @reference_ids.index(dc.id).nil?
  # don't reject if it is a "base" criteria (no references but must exist)
  to_reject &&= !base_criteria_defs.include?(dc.definition)
  # keep referral occurrence
  to_reject &&= dc.specific_occurrence_const.nil? ||
                dc.code_list_id != '2.16.840.1.113883.3.464.1003.101.12.1046'
  to_reject && !@data_criteria.detect do |dc2|
    similar_criteria = true
    similar_criteria &&= dc != dc2 # Don't check against itself
    similar_criteria &&= dc.code_list_id == dc2.code_list_id # Ensure code list ids are the same
    similar_criteria && detect_criteria_covered_by_criteria(dc, dc2)
  end.nil? # don't reject unless there is a similar element
end

#detect_criteria_covered_by_criteria(data_criteria, check_criteria) ⇒ Object

Check if one data criteria contains the others information by checking that one has everything the other has (or more)



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 87

def detect_criteria_covered_by_criteria(data_criteria, check_criteria)
  base_checks = true

  # Check whether basic features are the same
  base_checks &&= data_criteria.definition == check_criteria.definition # same definition
  base_checks &&= data_criteria.status == check_criteria.status # same status
  # same children
  base_checks &&= data_criteria.children_criteria.sort.join(',') == check_criteria.children_criteria.sort.join(',')
  # Ensure it doesn't contain basic elements that should not be removed
  base_checks &&= !data_criteria.variable # Ensure it's not a variable
  base_checks &&= data_criteria.derivation_operator.nil? # Ensure it doesn't have a derivation operator
  base_checks &&= data_criteria.subset_operators.empty? # Ensure it doesn't have a subset operator
  # Ensure it doesn't have Temporal References
  base_checks &&= data_criteria.temporal_references.nil? || data_criteria.temporal_references.empty?

  base_checks && complex_coverage(data_criteria, check_criteria)
end

#extract_source_data_criteria(data_criteria) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 43

def extract_source_data_criteria (data_criteria)
  # check if we have temporal references other non-SDC elements on this data criteria.
  # if we do, we need to create a new SDC to reference
  if !SourceDataCriteriaHelper.already_stripped?(data_criteria)
    candidate_sdc = SourceDataCriteriaHelper.strip_non_sc_elements(data_criteria.clone)
    candidate_sdc.instance_variable_set(:@id, "#{candidate_sdc.id}_source")
    candidate_sdc.instance_variable_set(:@source_data_criteria, candidate_sdc.id)

    existing_candidate = SourceDataCriteriaHelper.find_existing_source_data_criteria(@source_data_criteria, candidate_sdc)
    if existing_candidate
      candidate_sdc = existing_candidate
    else
      @source_data_criteria << candidate_sdc
      # Specific occurrence variables need a copy of the source in the data criteria to display variable results
      @data_criteria << candidate_sdc if data_criteria.is_derived_specific_occurrence_variable
    end

    data_criteria.instance_variable_set(:@source_data_criteria, candidate_sdc.id)
  end
end

#handle_variable(data_criteria, collapsed_source_data_criteria) ⇒ Object

Create grouper data criteria for encapsulating variable data criteria and update document data criteria list and references map



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 6

def handle_variable(data_criteria, collapsed_source_data_criteria)

  if data_criteria.is_derived_specific_occurrence_variable
    data_criteria.handle_derived_specific_occurrence_variable
    extract_source_data_criteria(data_criteria)
    return
  end

  tmp_id = data_criteria.id

  grouper_data_criteria = data_criteria.extract_variable_grouper
  return unless grouper_data_criteria
  @data_criteria_references[data_criteria.id] = data_criteria
  @data_criteria_references[grouper_data_criteria.id] = grouper_data_criteria

  # create a source data criteria for the grouping data critera we just created
  sdc = SourceDataCriteriaHelper.strip_non_sc_elements(grouper_data_criteria)
  @source_data_criteria << sdc
  
  # check if the original source has been collapsed when generating the SDC list (we need to reference the collapsed version in the sdc list)
  if collapsed_source_data_criteria[tmp_id]
    data_criteria.instance_variable_set(:@source_data_criteria, collapsed_source_data_criteria[tmp_id])
  else
    # check if we need to add _source suffix (most source data criteria are segmented with '_source' suffixes)
    data_criteria_sdc = find(@source_data_criteria, :id, "#{tmp_id}_source") 
    if data_criteria_sdc
      data_criteria.instance_variable_set(:@source_data_criteria, data_criteria_sdc.id)
      data_criteria_sdc.instance_variable_set(:@variable, false)
    # if it's not a derived data criteria then we may need to strip off temporal references, fields, etc as a new source data criteria
    elsif !['derived', 'satisfies_any', 'satisfies_all'].include?(data_criteria.definition)
      extract_source_data_criteria(data_criteria)
    end
  end

  @data_criteria << grouper_data_criteria
end

#same_field_values_check(data_criteria, check_criteria) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/hqmf-parser/2.0/document_helpers/doc_utilities.rb', line 119

def same_field_values_check(data_criteria, check_criteria)
  empty = data_criteria.field_values.nil? || data_criteria.field_values.empty?
  # Ignore STATUS (and ORDINAL for CMS172v5)
  # The meaning of status has changed over time. Laboratory test and procedure now use status differently.
  # This change is causing superficial discrepencies between the simplexml and hqmf regarding STATUS.
  dc_filtered = data_criteria.field_values.except('STATUS').except('ORDINAL')
  cc_filtered = check_criteria.field_values.except('STATUS').except('ORDINAL')
  left = dc_filtered.nil? || dc_filtered.empty? ? nil : dc_filtered.try(:to_json)
  right = cc_filtered.nil? || cc_filtered.empty? ? nil : cc_filtered.try(:to_json)
  return empty || left == right
end