canql 5.9.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df8c282627168b3542193781928b6be1e0b581c1f256b313b7fadfa4ba4adab
-  data.tar.gz: 89b9e95e96f7c8e1f4989ccdbc08462996ccb44246c0f6ced446e3b7b5ca3498
+  metadata.gz: a3c990a0548eca6080965ce9c1ef4d2a32f14557420941fbffa0f54051b4c79b
+  data.tar.gz: 82ecc585caca911ae3c7462f54e307fb75ec8ac261aa742c87dd49dca056ab29
 SHA512:
-  metadata.gz: 41ee65bb71db281d780de7083905ed120a5d046d0ec31980b21ffeeddf7b942233ceb8b5554cf19774d89f5628a40b8ef08e905514c621ae4b7691ecd9f9b8fb
-  data.tar.gz: 9741961b88ac1fc9b243f5c2217004357ee92188170dfd6f285bdf08702d8a2e2ee1ed59da9f883d2151b2f80f3bb49b076afaa2c044e79bd4c6e2f4fb0e6c72
+  metadata.gz: 7526043f1b2789fdd4c934b1616296e6742ede5e0f96ef55e6eb6e52fef981056b6288cee3fd863ca6705f269b72965e2d77c51dac47c9f3e3ec2f7c5308528f
+  data.tar.gz: b2b8feddac3280ebc84c053db3e5ec9c4f4eac641cbb23ad6b873e26e1f8df2e2b3c69827a024caeb019eebe2978ff17d4a54bfcc78c792074f93699df817ee9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## 6.0.0 / 2024-09-30
+### Changed
+* Changed the hes event filter to align with other new event filter
+### Added
+* Added event filters for birth, death, pregnancy loss and MSDS
+* Added 'number of fetuses in early pregnancy' to field existence modifier
+* Removed 'CODING_CLINIC' & 'REG_GROUP' actions from the action filter
+* Added 'BADGER_CHECKED', 'DELETE', 'FASP_CATEGORISATION', 'MSDS_SENT', 'RARE_DISEASE_TEAM', 'REG_CODING_FORUM' & 'SOURCES_CHECKED' actions to the action filter
+
 ## 5.9.0 / 2023-01-17
 * Added 'other' option to anomaly screening status filter (#90)
 

data/lib/canql/grammars/e_base_records.treetop

@@ -49,8 +49,10 @@ module Canql
     end
 
     rule accepted_action
-      'badger_search' / 'coding_clinic' / 'coding_group' / 'complete' / 'qa' /
-      'reg_group' / 'scr_checked' / 'scr_check' / 'search' / 'technical'
+      'badger_search' / 'badger_checked' / 'coding_group' / 'complete' /
+      'delete' / 'fasp_categorisation' / 'msds_sent'  / 'qa' /
+      'rare_disease_team' / 'reg_coding_forum' /
+      'scr_checked' / 'scr_check' / 'search' / 'sources_checked' / 'technical'
     end
 
     rule all_or_none_actions

data/lib/canql/grammars/events.treetop

@@ -0,0 +1,39 @@
+module Canql
+  grammar Events
+    rule events
+      and_keyword? existance_modifier:events_no_keyword? events_name event_object_keyword <Nodes::Events::WithCondition>
+    end
+
+    rule events_no_keyword
+      space ('no' / 'some') word_break
+    end
+
+    rule events_keywords
+      space ('birth' / 'death' / 'hes' / 'preg loss hes' / 'pregnancy loss hes' / 'preg loss bpas' / 'pregnancy loss bpas' / 'msds') word_break
+    end
+
+    rule relevant_events_keywords
+      space ('preg loss hes' / 'pregnancy loss hes' / 'preg loss bpas' / 'pregnancy loss bpas' / 'msds') word_break
+    end
+
+    rule events_name
+      (relevant_events / non_relevant_events)
+    end
+
+    rule non_relevant_events
+      event_type:events_keywords
+    end
+
+    rule relevant_events
+      event_relevance:event_relevant_keyword event_type:relevant_events_keywords
+    end
+
+    rule event_relevant_keyword
+      space ('linked' / 'relevant' / 'related' / 'unlinked' / 'irrelevant' / 'unrelated') word_break
+    end
+
+    rule event_object_keyword
+      space ('events' / 'event' / 'records' / 'record') word_break
+    end
+  end
+end

data/lib/canql/grammars/main.treetop

@@ -6,7 +6,7 @@ grammar Canql
   include GeneticTest
   include TestResult
   include TestResultGroup
-  include HesEvent
+  include Events
   include Dates
   include EBaseRecords
   include BatchTypes
@@ -131,11 +131,11 @@ grammar Canql
   rule case_with_conditions
      anomalies / genetic_tests / test_results / perinatal_hospital /
      case_field_existance / test_acceptance_existance / test_result_groups /
-     mother_conditions / action_or_ebr / hes_events
+     mother_conditions / action_or_ebr / events
   end
 
   rule patient_with_conditions
      anomalies / genetic_tests / test_results / patient_field_existance /
-     action_or_ebr / hes_events
+     action_or_ebr / events
   end
 end

data/lib/canql/grammars/patient.treetop

@@ -56,8 +56,8 @@ module Canql
         'delivery postcode' / 'booking postcode' / 'birth weight' /
         'place of delivery' / 'sex' / 'outcome' / 'edd' /
         'expected delivery date' / 'booking hospital' / 'screening status' /
-        'number of fetuses at delivery' / 'malformed in set' / 'gestation at delivery' /
-        'booking date'
+        'number of fetuses at delivery' / 'number of fetuses in early pregnancy' /
+        'malformed in set' / 'gestation at delivery' / 'booking date'
       )
     end
 

data/lib/canql/grammars.rb

@@ -14,5 +14,5 @@ Treetop.load File.expand_path('grammars/patient', File.dirname(__FILE__))
 Treetop.load File.expand_path('grammars/registry', File.dirname(__FILE__))
 Treetop.load File.expand_path('grammars/provider', File.dirname(__FILE__))
 Treetop.load File.expand_path('grammars/perinatal_hospital', File.dirname(__FILE__))
-Treetop.load File.expand_path('grammars/hes_event', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/events', File.dirname(__FILE__))
 Treetop.load File.expand_path('grammars/main', File.dirname(__FILE__))

data/lib/canql/nodes/events.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Canql #:nodoc: all
+  module Nodes
+    module Events
+      module WithCondition
+        def to_events
+          event_type = text_values_for_marker(:event_type).first.strip
+          event_relevance = text_values_for_marker(:event_relevance).first.to_s.strip
+          hash = existence_filter
+          hash['type'] = event_type_name[event_type]
+          hash['relevant'] = event_relevance_flag(event_relevance) || false
+
+          hash
+        end
+
+        def event_type_name
+          {
+            'birth' => 'birth',
+            'death' => 'death',
+            'hes' => 'hes',
+            'preg loss hes' => 'pregnancy_loss_hes',
+            'pregnancy loss hes' => 'pregnancy_loss_hes',
+            'preg loss bpas' => 'pregnancy_loss_bpas',
+            'pregnancy loss bpas' => 'pregnancy_loss_bpas',
+            'msds' => 'msds'
+          }
+        end
+
+        def event_relevance_flag(relevance)
+          %w[linked relevant related].include?(relevance)
+        end
+
+        def existence_filter
+          { Canql::EQUALS => existance_modifier.text_value.strip != 'no' }
+        end
+      end
+    end
+  end
+end

data/lib/canql/nodes/main.rb

@@ -32,7 +32,7 @@ module Canql #:nodoc: all
         sub_clauses = build_sub_clauses
 
         %i[
-          anomalies genetic_tests test_results test_result_groups test_acceptances hes_events
+          anomalies genetic_tests test_results test_result_groups test_acceptances events
         ].each do |condition_key|
           if sub_clauses[condition_key].present?
             conditions[condition_key.to_s] = { Canql::ALL => sub_clauses[condition_key] }
@@ -52,7 +52,7 @@ module Canql #:nodoc: all
             sub_clauses, element, :test_result_groups, :to_test_result_group
           )
           add_sub_clause(sub_clauses, element, :test_acceptances, :to_test_acceptance)
-          add_sub_clause(sub_clauses, element, :hes_events, :to_hes)
+          add_sub_clause(sub_clauses, element, :events, :to_events)
         end
         sub_clauses
       end

data/lib/canql/nodes/patient.rb

@@ -55,6 +55,7 @@ module Canql # :nodoc: all
           'booking hospital': { patient: 'booking_hospital' },
           'screening status': { patient: 'screeningstatus' },
           'number of fetuses at delivery': { patient: 'numoffetusesatdelivery' },
+          'number of fetuses in early pregnancy': { patient: 'numberoffetuses' },
           'malformed in set': { patient: 'malformedinset' },
           'gestation at delivery': { patient: 'gestationallength' },
           'booking date': { patient: 'firstbookingdate' }

data/lib/canql/nodes/patient_events.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Canql #:nodoc: all
+  module Nodes
+    module PatientEvents
+      module WithCondition
+        def to_events
+          event_name = event_type_name()
+          { "#{event_name}_event" => existence_filter }
+        end
+
+        def maternal_relevant_event_types
+          %w[pregnancy_loss_hes pregnancy_loss_bpas msds]
+        end
+
+        def event_type_name
+          map = {
+            'birth' => 'birth',
+            'death' => 'death',
+            'hes' => 'hes',
+            'preg loss hes' => 'pregnancy_loss_hes',
+            'pregnancy loss hes' => 'pregnancy_loss_hes',
+            'preg loss bpas' => 'pregnancy_loss_bpas',
+            'pregnancy loss bpas' => 'pregnancy_loss_bpas',
+            'msds' => 'msds'
+          }
+          map[event_type.text_value.strip]
+        end
+
+        def existence_filter
+          { Canql::EQUALS => existance_modifier.text_value.strip != 'no' }
+        end
+      end
+    end
+  end
+end

data/lib/canql/nodes.rb

@@ -22,4 +22,4 @@ require 'canql/nodes/patient'
 require 'canql/nodes/main'
 require 'canql/nodes/registry'
 require 'canql/nodes/perinatal_hospital'
-require 'canql/nodes/hes_event'
+require 'canql/nodes/events'

data/lib/canql/version.rb

@@ -2,5 +2,5 @@
 
 # This stores the current version of the Canql gem
 module Canql
-  VERSION = '5.9.0'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canql
 version: !ruby/object:Gem::Version
-  version: 5.9.0
+  version: 6.0.0
 platform: ruby
 authors:
 - NHSD NDRS Development Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -229,8 +229,8 @@ files:
 - lib/canql/grammars/batch_types.treetop
 - lib/canql/grammars/dates.treetop
 - lib/canql/grammars/e_base_records.treetop
+- lib/canql/grammars/events.treetop
 - lib/canql/grammars/genetic_test.treetop
-- lib/canql/grammars/hes_event.treetop
 - lib/canql/grammars/main.treetop
 - lib/canql/grammars/patient.treetop
 - lib/canql/grammars/perinatal_hospital.treetop
@@ -244,10 +244,11 @@ files:
 - lib/canql/nodes/batch_types.rb
 - lib/canql/nodes/dates.rb
 - lib/canql/nodes/e_base_records.rb
+- lib/canql/nodes/events.rb
 - lib/canql/nodes/genetic_test.rb
-- lib/canql/nodes/hes_event.rb
 - lib/canql/nodes/main.rb
 - lib/canql/nodes/patient.rb
+- lib/canql/nodes/patient_events.rb
 - lib/canql/nodes/perinatal_hospital.rb
 - lib/canql/nodes/registry.rb
 - lib/canql/nodes/test_result.rb
@@ -274,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Congenital Anomaly Natural Query Language

data/lib/canql/grammars/hes_event.treetop

@@ -1,15 +0,0 @@
-module Canql
-  grammar HesEvent
-    rule hes_events
-      and_keyword? existance_modifier:hes_no_keyword? hes_keyword <Nodes::HesEvent::WithCondition>
-    end
-
-    rule hes_no_keyword
-      space ('no' / 'some') word_break
-    end
-
-    rule hes_keyword
-      space ('hes events' / 'hes records') word_break
-    end
-  end
-end

data/lib/canql/nodes/hes_event.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Canql #:nodoc: all
-  module Nodes
-    module HesEvent
-      module WithCondition
-        def to_hes
-          { 'exists' => existance_filter }
-        end
-
-        def existance_filter
-          { Canql::EQUALS => existance_modifier.text_value.strip != 'no' }
-        end
-      end
-    end
-  end
-end