cqm-models 1.1.1.0 → 3.0.2

data/app/models/qdm/{result_component.rb → attributes/result_component.rb}

@@ -1,9 +1,7 @@
 module QDM
   # app/models/qdm/result_component.rb
-  class ResultComponent < DataElement
+  class ResultComponent < Component
     include Mongoid::Document
-    embedded_in :patient
     field :referenceRange, type: QDM::Interval
-    field :qdmVersion, type: String, default: '5.4'
   end
 end

data/app/models/qdm/basetypes/code.rb

@@ -1,20 +1,19 @@
 module QDM
   # Represents a Code
   class Code
-    attr_accessor :code, :codeSystem, :descriptor, :codeSystemOid, :version
+    attr_accessor :code, :display, :system, :version
 
     # Code and code system are required (at minimum).
-    def initialize(code, codeSystem, descriptor = nil, codeSystemOid = nil, version = nil)
+    def initialize(code, sys, display = nil, version = nil)
       @code = code
-      @codeSystem = codeSystem
-      @descriptor = descriptor
-      @codeSystemOid = codeSystemOid
+      @system = sys
+      @display = display
       @version = version
     end
 
     # Converts an object of this instance into a database friendly value.
     def mongoize
-      { code: @code, codeSystem: @codeSystem, descriptor: @descriptor, codeSystemOid: @codeSystemOid, version: @version, _type: 'QDM::Code' }
+      { code: @code, system: @system, display: @display, version: @version, _type: 'QDM::Code' }
     end
 
     class << self
@@ -22,11 +21,12 @@ module QDM
       # this custom class from it.
       #
       # The array elements in demongoize are the same 5 elements used in mongoize, i.e.
-      # [ code, codeSystem, descriptor, codeSystemOid, version ].
+      # [ code, system, display, version ].
       def demongoize(object)
         return nil unless object
+
         object = object.symbolize_keys
-        QDM::Code.new(object[:code], object[:codeSystem], object[:descriptor], object[:codeSystemOid], object[:version])
+        QDM::Code.new(object[:code], object[:system], object[:display], object[:version])
       end
 
       # Takes any possible object and converts it to how it would be
@@ -37,8 +37,7 @@ module QDM
         when QDM::Code then object.mongoize
         when Hash
           object = object.symbolize_keys
-          codeSystem = object[:system] ? object[:system] : object[:codeSystem]
-          QDM::Code.new(object[:code], codeSystem, object[:descriptor], object[:codeSystemOid], object[:version]).mongoize
+          QDM::Code.new(object[:code], object[:system], object[:display], object[:version]).mongoize
         else object
         end
       end

data/app/models/qdm/basetypes/data_element.rb

@@ -14,12 +14,12 @@ module QDM
     # Valueset oid of the specific type.
     field :codeListId, type: String
 
-    embeds_one :id, class_name: 'QDM::Id'
+    field :id, type: String
 
     def initialize(options = {})
       super(options)
       # default id to the mongo ObjectId for this DataElement if it isnt already defined
-      self.id = QDM::Id.new(value: _id.to_s) unless id?
+      self.id = _id.to_s unless id?
     end
 
     # Returns the attribute requested on the datatype.
@@ -31,7 +31,7 @@ module QDM
     # to the CQL execution engine.
     def code_system_pairs
       codes.collect do |code|
-        { code: code.code, system: code.codeSystem }
+        { code: code.code, system: code.system }
       end
     end
 
@@ -58,16 +58,9 @@ module QDM
     # Given value should be in seconds. Positive values shift forward, negative
     # values shift backwards.
     def shift_dates(seconds)
-      # Iterate over fields
       fields.keys.each do |field|
-        # Check if field is a DateTime
-        if send(field).is_a? DateTime
-          send(field + '=', (send(field).to_time + seconds.seconds).to_datetime)
-        end
-        # Check if field is an Interval
-        if (send(field).is_a? Interval) || (send(field).is_a? DataElement)
-          send(field + '=', send(field).shift_dates(seconds))
-        end
+        send(field + '=', (send(field).to_time + seconds.seconds).to_datetime) if send(field).is_a? DateTime
+        send(field + '=', send(field).shift_dates(seconds)) if (send(field).is_a? Interval) || (send(field).is_a? DataElement)
 
         # Special case for facility locations
         if field == 'facilityLocations'
@@ -89,12 +82,71 @@ module QDM
       facility_location['locationPeriod'][:high] = (facility_location['locationPeriod'][:high].to_time + seconds).to_datetime
     end
 
+    # The necessary reason for this function is to avoid a problem when shifting
+    # past a year that is a leap year. February 29th dates are handled by moving
+    # back to the 28th in non leap years
+    def shift_years(year_shift)
+      fields.keys.each do |field|
+        if send(field).is_a?(QDM::Date) || send(field).is_a?(DateTime)
+          # Do not shift Time values. They are stored as DateTimes with year 0.
+          next if send(field).year.zero?
+          raise RangeError, 'Year was shifted after 9999 or before 0001' if send(field).year + year_shift > 9999 || send(field).year + year_shift < 1
+
+          if send(field).month == 2 && send(field).day == 29 && !::Date.leap?(year_shift + send(field).year)
+            if send(field).is_a?(QDM::Date)
+              shifted_date = send(field)
+              shifted_date.year = shifted_date.year + year_shift
+              shifted_date.day = 28
+              send(field + '=', shifted_date)
+            else
+              send(field + '=', send(field).change(year: year_shift + send(field).year, day: 28))
+            end
+          elsif send(field).is_a?(QDM::Date)
+            shifted_date = send(field)
+            shifted_date.year = shifted_date.year + year_shift
+            send(field + '=', shifted_date)
+          else
+            send(field + '=', send(field).change(year: year_shift + send(field).year))
+          end
+        end
+
+        if send(field).is_a? FacilityLocation
+          facility_location = send(field)
+          unless facility_location.nil?
+            shift_facility_location_years(facility_location, year_shift)
+            send(field + '=', facility_location)
+          end
+        end
+
+        if field == 'facilityLocations'
+          facilityLocations = send(field)
+          unless facilityLocations.nil?
+            shiftedFacilityLocations = []
+            facilityLocations.each do |location|
+              # Need to convert to a QDM::FacilityLocation because it is being passed in as a Hash
+              facilityLocation = QDM::FacilityLocation.new(location)
+              shift_facility_location_years(facilityLocation, year_shift)
+              shiftedFacilityLocations << facilityLocation
+            end
+            send(field + '=', shiftedFacilityLocations)
+          end
+        end
+
+        send(field + '=', send(field).shift_years(year_shift)) if (send(field).is_a? Interval) || (send(field).is_a? DataElement)
+      end
+    end
+
+    def shift_facility_location_years(facility_location, year_shift)
+      facility_location.locationPeriod = facility_location.locationPeriod.shift_years(year_shift)
+    end
+
     class << self
       # Get the object as it was stored in the database, and instantiate
       # this custom class from it.
       #
       def demongoize(object)
         return nil unless object
+
         object = object.symbolize_keys
         if object.is_a?(Hash)
           data_element = QDM.const_get(object[:_type])

data/app/models/qdm/basetypes/date.rb

@@ -0,0 +1,39 @@
+module QDM
+  # Represents a QDM/CQL Date
+  class Date
+    attr_accessor :year, :month, :day
+
+    def initialize(year = nil, month = nil, day = nil)
+      @year = year
+      @month = month
+      @day = day
+    end
+
+    # Converts an object of this instance into a database friendly value.
+    def mongoize
+      "#{format('%04d', year)}-#{format('%02d', month)}-#{format('%02d', day)}"
+    end
+
+    class << self
+      # Get the string as it was stored in the database, and instantiate
+      # this custom class from it.
+      def demongoize(date_str)
+        return nil unless date_str
+
+        year = date_str[0..3].to_i
+        month = date_str[5..6].to_i
+        day = date_str[8..10].to_i
+        QDM::Date.new(year, month, day)
+      end
+
+      # Converts the object that was supplied to a criteria and converts it
+      # into a database friendly form.
+      def evolve(object)
+        case object
+        when QDM::Date then object.mongoize
+        else object
+        end
+      end
+    end
+  end
+end

data/app/models/qdm/basetypes/interval.rb

@@ -22,9 +22,7 @@ module QDM
     #
     # NOTE: This will only shift if @high and @low are DateTimes.
     def shift_dates(seconds)
-      if (@low.is_a? DateTime) || (@low.is_a? Time)
-        @low = (@low.utc.to_time + seconds.seconds).to_datetime.new_offset(0)
-      end
+      @low = (@low.utc.to_time + seconds.seconds).to_datetime.new_offset(0) if (@low.is_a? DateTime) || (@low.is_a? Time)
       if (@high.is_a? DateTime) || (@high.is_a? Time)
         @high = (@high.utc.to_time + seconds.seconds).to_datetime.new_offset(0)
         @high = @high.year > 9999 ? @high.change(year: 9999) : @high
@@ -32,6 +30,30 @@ module QDM
       self
     end
 
+    def shift_years(year_shift)
+      if (@low.is_a? DateTime) || (@low.is_a? Time)
+        raise RangeError, 'Year was shifted after 9999 or before 0001' if @low.year + year_shift < 1 || @low.year + year_shift > 9999
+
+        low_shift = @low.year + year_shift
+        @low = if @low.month == 2 && @low.day == 29 && !::Date.leap?(low_shift)
+                 @low.change(year: low_shift, day: 28)
+               else
+                 @low.change(year: low_shift)
+               end
+      end
+      if (@high.is_a? DateTime) || (@high.is_a? Time)
+        raise RangeError, 'Year was shifted after 9999 or before 0001' if @high.year + year_shift < 1 || @high.year + year_shift > 9999
+
+        high_shift = @high.year + year_shift
+        @high = if @high.month == 2 && @high.day == 29 && !::Date.leap?(high_shift)
+                  @high.change(year: high_shift, day: 28)
+                else
+                  @high.change(year: high_shift)
+                end
+      end
+      self
+    end
+
     class << self
       # Get the object as it was stored in the database, and instantiate
       # this custom class from it.
@@ -40,6 +62,7 @@ module QDM
       # [ low, high ].
       def demongoize(object)
         return nil unless object
+
         object = object.symbolize_keys
         fix_datetime(object)
         QDM::Interval.new(object[:low], object[:high], object[:lowClosed], object[:highClosed]) if object.is_a?(Hash)

data/app/models/qdm/basetypes/quantity.rb

@@ -22,6 +22,7 @@ module QDM
       # [ value, unit ].
       def demongoize(object)
         return nil unless object
+
         object = object.symbolize_keys
         QDM::Quantity.new(object[:value], object[:unit]) if object.is_a?(Hash)
       end

data/app/models/qdm/basetypes/ratio.rb

@@ -22,6 +22,7 @@ module QDM
       # [ numerator, denominator ].
       def demongoize(object)
         return nil unless object
+
         object = object.symbolize_keys
         QDM::Ratio.new(object[:numerator], object[:denominator]) if object.is_a?(Hash)
       end

data/app/models/qdm/care_goal.rb

@@ -3,12 +3,14 @@ module QDM
   class CareGoal < DataElement
     include Mongoid::Document
     embedded_in :patient
+    field :statusDate, type: Date
     field :relevantPeriod, type: QDM::Interval
-    embeds_many :relatedTo, class_name: 'QDM::Id'
+    field :relatedTo, type: Array
     field :targetOutcome
+    embeds_one :performer, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Care Goal'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.7'
     field :qdmCategory, type: String, default: 'care_goal'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/communication_performed.rb

@@ -6,15 +6,16 @@ module QDM
     field :authorDatetime, type: DateTime
     field :category, type: QDM::Code
     field :medium, type: QDM::Code
-    field :sender, type: QDM::Code
-    field :recipient, type: QDM::Code
-    embeds_many :relatedTo, class_name: 'QDM::Id'
-    field :relevantPeriod, type: QDM::Interval
+    embeds_one :sender, class_name: 'QDM::Entity'
+    embeds_one :recipient, class_name: 'QDM::Entity'
+    field :relatedTo, type: Array
+    field :sentDatetime, type: DateTime
+    field :receivedDatetime, type: DateTime
     field :negationRationale, type: QDM::Code
     field :qdmTitle, type: String, default: 'Communication, Performed'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.132'
     field :qdmCategory, type: String, default: 'communication'
     field :qdmStatus, type: String, default: 'performed'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/device_applied.rb

@@ -4,14 +4,16 @@ module QDM
     include Mongoid::Document
     embedded_in :patient
     field :authorDatetime, type: DateTime
+    field :relevantDatetime, type: DateTime
     field :relevantPeriod, type: QDM::Interval
     field :negationRationale, type: QDM::Code
     field :reason, type: QDM::Code
     field :anatomicalLocationSite, type: QDM::Code
+    embeds_one :performer, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Device, Applied'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.13'
     field :qdmCategory, type: String, default: 'device'
     field :qdmStatus, type: String, default: 'applied'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/device_order.rb

@@ -6,10 +6,11 @@ module QDM
     field :authorDatetime, type: DateTime
     field :negationRationale, type: QDM::Code
     field :reason, type: QDM::Code
+    embeds_one :requester, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Device, Order'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.15'
     field :qdmCategory, type: String, default: 'device'
     field :qdmStatus, type: String, default: 'order'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/device_recommended.rb

@@ -6,10 +6,11 @@ module QDM
     field :authorDatetime, type: DateTime
     field :negationRationale, type: QDM::Code
     field :reason, type: QDM::Code
+    embeds_one :requester, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Device, Recommended'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.16'
     field :qdmCategory, type: String, default: 'device'
     field :qdmStatus, type: String, default: 'recommended'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/diagnosis.rb

@@ -7,10 +7,11 @@ module QDM
     field :prevalencePeriod, type: QDM::Interval
     field :anatomicalLocationSite, type: QDM::Code
     field :severity, type: QDM::Code
+    embeds_one :recorder, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Diagnosis'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.110'
     field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.135'
     field :qdmCategory, type: String, default: 'condition'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/diagnostic_study_order.rb

@@ -6,10 +6,11 @@ module QDM
     field :authorDatetime, type: DateTime
     field :reason, type: QDM::Code
     field :negationRationale, type: QDM::Code
+    embeds_one :requester, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Diagnostic Study, Order'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.22'
     field :qdmCategory, type: String, default: 'diagnostic_study'
     field :qdmStatus, type: String, default: 'order'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/diagnostic_study_performed.rb

@@ -4,6 +4,7 @@ module QDM
     include Mongoid::Document
     embedded_in :patient
     field :authorDatetime, type: DateTime
+    field :relevantDatetime, type: DateTime
     field :relevantPeriod, type: QDM::Interval
     field :reason, type: QDM::Code
     field :result
@@ -13,10 +14,11 @@ module QDM
     field :facilityLocation, type: QDM::FacilityLocation
     field :negationRationale, type: QDM::Code
     field :components, type: Array
+    embeds_one :performer, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Diagnostic Study, Performed'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.23'
     field :qdmCategory, type: String, default: 'diagnostic_study'
     field :qdmStatus, type: String, default: 'performed'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/diagnostic_study_recommended.rb

@@ -5,11 +5,12 @@ module QDM
     embedded_in :patient
     field :authorDatetime, type: DateTime
     field :negationRationale, type: QDM::Code
+    embeds_one :requester, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Diagnostic Study, Recommended'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.24'
     field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.19'
     field :qdmCategory, type: String, default: 'diagnostic_study'
     field :qdmStatus, type: String, default: 'recommended'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/encounter_order.rb

@@ -7,10 +7,12 @@ module QDM
     field :reason, type: QDM::Code
     field :facilityLocation, type: QDM::FacilityLocation
     field :negationRationale, type: QDM::Code
+    embeds_one :requester, class_name: 'QDM::Entity'
+    field :priority, type: QDM::Code
     field :qdmTitle, type: String, default: 'Encounter, Order'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.27'
     field :qdmCategory, type: String, default: 'encounter'
     field :qdmStatus, type: String, default: 'order'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end