hqmf-parser 1.0.0

data/lib/hqmf-model/document.rb

@@ -0,0 +1,172 @@
+module HQMF
+  # Class representing an HQMF document
+  class Document
+    
+    MEASURE_PERIOD_ID = "MeasurePeriod"
+
+    STRATIFIED_POPULATION_TEMPLATE_ID = '2.16.840.1.113883.3.100.1.2'
+    STRATIFIED_POPULATION_TEMPLATE_TITLE = 'Stratified'
+
+    include HQMF::Conversion::Utilities
+
+    attr_reader :id, :title, :description, :measure_period, :attributes, :populations, :source_data_criteria, :hqmf_id, :hqmf_set_id, :hqmf_version_number
+  
+    # Create a new HQMF::Document which can be converted to JavaScript
+    # @param [String] id
+    # @param [String] hqmf_id
+    # @param [String] hqmf_set_id
+    # @param [String] hqmf_version_number
+    # @param [String] title
+    # @param [String] description
+    # @param [Array#PopulationCritera] population_criteria 
+    # @param [Array#DataCriteria] data_criteria
+    # @param [Array#DataCriteria] source_data_criteria
+    # @param [Array#Attribute] attributes
+    # @param [Array#Hash] populations
+    # @param [Range] measure_period
+    def initialize(id, hqmf_id, hqmf_set_id, hqmf_version_number, title, description, population_criteria, data_criteria, source_data_criteria, attributes, measure_period, populations=nil)
+      @id = id
+      @hqmf_id = hqmf_id
+      @hqmf_set_id = hqmf_set_id
+      @hqmf_version_number = hqmf_version_number
+      @title = title
+      @description = description
+      @population_criteria = population_criteria
+      @data_criteria = data_criteria
+      @source_data_criteria = source_data_criteria
+      @attributes = attributes
+      @populations = populations || [
+        {
+          HQMF::PopulationCriteria::IPP => HQMF::PopulationCriteria::IPP,
+          HQMF::PopulationCriteria::DENOM => HQMF::PopulationCriteria::DENOM,
+          HQMF::PopulationCriteria::NUMER => HQMF::PopulationCriteria::NUMER,
+          HQMF::PopulationCriteria::EXCEP => HQMF::PopulationCriteria::EXCEP,
+          HQMF::PopulationCriteria::DENEX => HQMF::PopulationCriteria::DENEX
+        }
+      ]
+      @measure_period = measure_period
+    end
+    
+    # Create a new HQMF::Document from a JSON hash keyed with symbols
+    def self.from_json(json)
+      id = json["id"]
+      hqmf_id = json["hqmf_id"]
+      hqmf_set_id = json["hqmf_set_id"]
+      hqmf_version_number = json["hqmf_version_number"]
+      title = json["title"]
+      description = json["description"]
+      
+      population_criterias = []
+      json["population_criteria"].each do |key, population_criteria|
+        population_criterias << HQMF::PopulationCriteria.from_json(key.to_s, population_criteria)
+      end if json['population_criteria']
+
+      data_criterias = []
+      json["data_criteria"].each do |key, data_criteria|
+        data_criterias << HQMF::DataCriteria.from_json(key.to_s, data_criteria)
+      end
+
+      source_data_criterias = []
+      json["source_data_criteria"].each do |key, data_criteria|
+        source_data_criterias << HQMF::DataCriteria.from_json(key.to_s, data_criteria)
+      end
+      
+      populations = json["populations"] if json["populations"]
+
+      attributes = json["attributes"].map {|attribute| HQMF::Attribute.from_json(attribute)} if json["attributes"]
+
+      measure_period = HQMF::Range.from_json(json["measure_period"]) if json["measure_period"]
+      HQMF::Document.new(id, hqmf_id, hqmf_set_id, hqmf_version_number, title, description, population_criterias, data_criterias, source_data_criterias, attributes, measure_period,populations)
+    end
+    
+    def to_json
+      json = build_hash(self, [:id, :hqmf_id, :hqmf_set_id, :hqmf_version_number, :title, :description])
+
+      json[:population_criteria] = {}
+      @population_criteria.each do |population|
+        json[:population_criteria].merge! population.to_json
+      end
+
+      json[:data_criteria] = {}
+      @data_criteria.each do |data|
+        json[:data_criteria].merge! data.to_json
+      end
+
+      json[:source_data_criteria] = {}
+      @source_data_criteria.each do |data|
+        json[:source_data_criteria].merge! data.to_json
+      end
+      
+      x = nil
+      json[:attributes] = x if x = json_array(@attributes)
+      
+      json[:populations] = @populations
+      
+      json[:measure_period] = @measure_period.to_json
+
+      json
+    end
+    
+    
+    # Get all the population criteria defined by the measure
+    # @return [Array] an array of HQMF::PopulationCriteria
+    def all_population_criteria
+      @population_criteria
+    end
+    
+    # Get a specific population criteria by id.
+    # @param [String] id the population identifier
+    # @return [HQMF::PopulationCriteria] the matching criteria, raises an Exception if not found
+    def population_criteria(id)
+      find(@population_criteria, :id, id)
+    end
+    
+    # Get all the data criteria defined by the measure
+    # @return [Array] an array of HQMF::DataCriteria describing the data elements used by the measure
+    def all_data_criteria
+      @data_criteria
+    end
+    
+    # Get the source data criteria that are specific occurrences
+    # @return [Array] an array of HQMF::DataCriteria describing the data elements used by the measure that are specific occurrences
+    def specific_occurrence_source_data_criteria
+      return [] if @source_data_criteria.nil?
+      @source_data_criteria.select {|dc| !dc.specific_occurrence.nil?}
+    end
+    
+
+    # @return [Array] an array of HQMF::DataCriteria ids that are actually used in the measure
+    def referenced_data_criteria
+      data_criteria_ids = []
+      @population_criteria.each do |population|
+        data_criteria_ids.concat(population.referenced_data_criteria)
+      end
+      references = []
+      data_criteria_ids.each do |id|
+        dc = data_criteria(id)
+        references << id
+        from_dc = dc.referenced_data_criteria(self)
+        references.concat(from_dc)
+      end
+      used_dc = []
+      references.uniq.each do |id|
+        used_dc << data_criteria(id)
+      end
+      used_dc
+    end
+    
+    
+    # Get a specific data criteria by id.
+    # @param [String] id the data criteria identifier
+    # @return [HQMF::DataCriteria] the matching data criteria, raises an Exception if not found
+    def data_criteria(id)
+      find(@data_criteria, :id, id)
+    end
+    
+    private
+    
+    def find(collection, attribute, value)
+      collection.find {|e| e.send(attribute)==value}
+    end
+  end
+end

data/lib/hqmf-model/population_criteria.rb

@@ -0,0 +1,90 @@
+module HQMF
+  # Represents an HQMF population criteria, also supports all the same methods as
+  # HQMF::Precondition
+  class PopulationCriteria
+  
+    include HQMF::Conversion::Utilities
+
+    attr_reader :preconditions, :id, :type, :title, :hqmf_id
+    
+    IPP = 'IPP'
+    DENOM = 'DENOM'
+    NUMER = 'NUMER'
+    EXCEP = 'EXCEP'
+    DENEX = 'DENEX'
+    
+    ALL_POPULATION_CODES = [IPP, DENOM, NUMER, EXCEP, DENEX]
+    
+    # Create a new population criteria
+    # @param [String] id
+    # @param [String] hqmf_id
+    # @param [Array#Precondition] preconditions 
+    # @param [String] title (optional)
+    def initialize(id, hqmf_id, type, preconditions, title='')
+      @id = id
+      @hqmf_id = hqmf_id
+      @preconditions = preconditions
+      @type = type
+      @title=title
+    end
+    
+    # Create a new population criteria from a JSON hash keyed off symbols
+    def self.from_json(id, json)
+      preconditions = json["preconditions"].map do |precondition|
+        HQMF::Precondition.from_json(precondition)
+      end if json['preconditions']
+      type = json["type"]
+      title = json['title']
+      hqmf_id = json['hqmf_id']
+      
+      HQMF::PopulationCriteria.new(id, hqmf_id, type, preconditions, title)
+    end
+    
+    def to_json
+      {self.id.to_sym => base_json}
+    end
+    
+    def base_json
+      x = nil
+      json = build_hash(self, [:conjunction?, :type, :title, :hqmf_id])
+      json[:preconditions] = x if x = json_array(@preconditions)
+      json
+    end
+    
+    # Return true of this precondition represents a conjunction with nested preconditions
+    # or false of this precondition is a reference to a data criteria
+    def conjunction?
+      true
+    end
+
+    # Get the conjunction code, e.g. allTrue, atLeastOneTrue
+    # @return [String] conjunction code
+    def conjunction_code
+      
+      case @type
+      when IPP, DENOM, NUMER
+        HQMF::Precondition::ALL_TRUE
+      when EXCEP, DENEX, EXCEP
+        HQMF::Precondition::AT_LEAST_ONE_TRUE
+      else
+        raise "Unknown population type [#{@type}]"
+      end
+      
+    end
+    
+    # Can't have negation on population so this is the same as conjunction_code
+    def conjunction_code_with_negation
+      conjunction_code
+    end
+    
+    def referenced_data_criteria
+      data_criteria_ids = []
+      @preconditions.each do |precondition|
+        data_criteria_ids.concat(precondition.referenced_data_criteria)
+      end if @preconditions
+      data_criteria_ids
+    end
+    
+  end
+  
+end

data/lib/hqmf-model/precondition.rb

@@ -0,0 +1,85 @@
+module HQMF
+  
+  class Precondition
+
+    include HQMF::Conversion::Utilities
+    
+    AT_LEAST_ONE_TRUE = 'atLeastOneTrue'
+    AT_LEAST_ONE_FALSE = 'atLeastOneFalse'
+    ALL_TRUE = 'allTrue'
+    ALL_FALSE = 'allFalse'
+    NEGATIONS = {
+      AT_LEAST_ONE_TRUE => ALL_FALSE,
+      ALL_FALSE => AT_LEAST_ONE_TRUE,
+      ALL_TRUE => AT_LEAST_ONE_FALSE,
+      AT_LEAST_ONE_FALSE => ALL_TRUE
+    }
+    
+    attr_reader :id, :preconditions, :reference, :conjunction_code
+    attr_accessor :negation
+  
+    # Create a new population criteria
+    # @param [Array#Precondition] preconditions 
+    # @param [Reference] reference
+    # @param [String] conjunction_code
+    def initialize(id, preconditions, reference, conjunction_code, negation)
+      @preconditions = preconditions || []
+      @reference = reference
+      @conjunction_code = conjunction_code
+      @negation = negation
+      @id = id
+    end
+    
+    def conjunction_code_with_negation
+      if negation
+        NEGATIONS[conjunction_code]
+      else
+        conjunction_code
+      end
+    end
+    
+    # Create a new population criteria from a JSON hash keyed off symbols
+    def self.from_json(json)
+      preconditions = []
+      id = json["id"] if json["id"]
+      preconditions = json["preconditions"].map {|precondition| HQMF::Precondition.from_json(precondition)} if json["preconditions"]
+      reference = Reference.new(json["reference"]) if json["reference"] 
+      conjunction_code = json["conjunction_code"] if json["conjunction_code"]
+      negation = json["negation"] if json["negation"]
+      
+      HQMF::Precondition.new(id, preconditions, reference, conjunction_code, negation)
+    end
+    
+    def to_json
+      x = nil
+      json = {}
+      json[:id] = self.id
+      json[:reference] = self.reference.id if self.reference
+      json[:preconditions] = x if x = json_array(@preconditions)
+      json[:conjunction_code] = self.conjunction_code if self.conjunction_code
+      json[:negation] = self.negation if self.negation
+      json
+    end
+    
+    # Return true of this precondition represents a conjunction with nested preconditions
+    # or false of this precondition is a reference to a data criteria
+    def conjunction?
+      @preconditions.length>0
+    end
+
+    def referenced_data_criteria
+      data_criteria_ids = []
+      if @preconditions.empty?
+        data_criteria_ids << self.reference.id
+      else
+        @preconditions.each do |precondition|
+          data_criteria_ids.concat(precondition.referenced_data_criteria)
+        end
+      end
+      data_criteria_ids
+    end
+
+  end
+  
+  
+end

data/lib/hqmf-model/types.rb

@@ -0,0 +1,318 @@
+module HQMF
+
+  # Used to represent 'any value' in criteria that require a value be present but
+  # don't specify any restrictions on that value
+  class AnyValue
+    include HQMF::Conversion::Utilities
+    attr_reader :type
+    
+    def initialize(type='ANYNonNull')
+      @type = type 
+    end
+    
+    def derived?
+      false
+    end
+
+    def self.from_json(json)
+      type = json["type"] || 'ANYNonNull'
+      HQMF::AnyValue.new(type)
+    end
+    
+    def to_json
+      hash = build_hash(self, [:type])
+      hash
+    end    
+  end
+  
+  # Represents a bound within a HQMF pauseQuantity, has a value, a unit and an
+  # inclusive/exclusive indicator
+  class Value
+    include HQMF::Conversion::Utilities
+    attr_reader :unit,:expression
+    attr_accessor :type, :value, :inclusive
+    
+    # Create a new HQMF::Value
+    # @param [String] type
+    # @param [String] unit
+    # @param [String] value
+    # @param [Boolean] inclusive
+    # @param [Boolean] derived
+    # @param [String] expression
+    def initialize(type,unit,value,inclusive,derived,expression)
+      @type = type || 'PQ'
+      @unit = unit
+      @value = value
+      @inclusive = inclusive == nil ? true : inclusive
+      @derived = derived || false
+      @expression = expression
+    end
+    
+    def self.from_json(json)
+      type = json["type"] if json["type"]
+      unit = json["unit"] if json["unit"]
+      value = json["value"] if json["value"]
+      inclusive = json["inclusive?"] unless json["inclusive?"].nil?
+      derived = json["derived?"] unless json["derived?"].nil?
+      expression = json["expression"] if json["expression"]
+      
+      HQMF::Value.new(type,unit,value,inclusive,derived,expression)
+    end
+    
+    
+    def inclusive?
+      @inclusive
+    end
+
+    def derived?
+      @derived
+    end
+    
+    def to_json
+      build_hash(self, [:type,:unit,:value,:inclusive?,:derived?,:expression])
+    end
+    
+    def stringify
+      "#{inclusive? ? '=' : ''}#{value}#{unit ? ' '+unit : ''}"
+    end
+
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+  end
+  
+  # Represents a HQMF physical quantity which can have low and high bounds
+  class Range
+    include HQMF::Conversion::Utilities
+    attr_accessor :type, :low, :high, :width
+    
+    # Create a new HQMF::Value
+    # @param [String] type
+    # @param [Value] low
+    # @param [Value] high
+    # @param [Value] width
+    def initialize(type,low,high,width)
+      @type = type || 'IVL_PQ'
+      @low = low
+      @high = high
+      @width = width
+    end
+    
+    def self.from_json(json)
+      type = json["type"] if json["type"]
+      low = HQMF::Value.from_json(json["low"]) if json["low"]
+      high = HQMF::Value.from_json(json["high"]) if json["high"]
+      width = HQMF::Value.from_json(json["width"]) if json["width"]
+      
+      HQMF::Range.new(type,low,high,width)
+    end
+    
+    def to_json
+      json = build_hash(self, [:type])
+      json[:low] = self.low.to_json if self.low
+      json[:high] = self.high.to_json if self.high
+      json[:width] = self.width.to_json if self.width
+      json
+    end
+    
+    def stringify
+      operator = ""
+      if (@high && @low)
+        if (@high.value == @low.value and @high.inclusive? and low.inclusive?)
+          "#{@low.stringify}"
+        else
+          ">#{@low.stringify} and <#{@high.stringify}}"
+        end
+      elsif (@high)
+        "<#{@high.stringify}"
+      elsif (@low)
+        ">#{@low.stringify}"
+      else
+        raise "cannot convert range to string"
+      end
+    end
+    
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+    
+  end
+  
+  # Represents a HQMF effective time which is a specialization of a interval
+  class EffectiveTime < Range
+    def initialize(low,high,width)
+      super('IVL_TS', low, high, width)
+    end
+    
+    def type
+      'IVL_TS'
+    end
+    
+  end
+  
+  # Represents a HQMF CD value which has a code and codeSystem
+  class Coded
+    include HQMF::Conversion::Utilities
+    attr_reader :type, :system, :code, :code_list_id, :title
+    
+    # Create a new HQMF::Coded
+    # @param [String] type
+    # @param [String] system
+    # @param [String] code
+    # @param [String] code_list_id
+    def initialize(type,system,code,code_list_id=nil,title=nil)
+      @type = type
+      @system = system
+      @code = code
+      @code_list_id = code_list_id
+      @title = title
+    end
+    
+    def self.for_code_list(code_list_id,title=nil)
+      HQMF::Coded.new('CD',nil,nil,code_list_id,title)
+    end
+    
+    def self.for_single_code(system,code,title=nil)
+      HQMF::Coded.new('CD',system,code,nil,title)
+    end
+    
+    def self.from_json(json)
+      type = json["type"] if json["type"]
+      system = json["system"] if json["system"]
+      code = json["code"] if json["code"]
+      code_list_id = json["code_list_id"] if json["code_list_id"]
+      title = json["title"] if json["title"]
+      
+      HQMF::Coded.new(type,system,code,code_list_id,title)
+    end
+    
+    def to_json
+      build_hash(self, [:type,:system,:code,:code_list_id,:title])
+    end
+    
+    def value
+      code
+    end
+
+    def derived?
+      false
+    end
+
+    def unit
+      nil
+    end
+    
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+  end
+
+  class TemporalReference
+    include HQMF::Conversion::Utilities
+    
+    TYPES = ['DURING','SBS','SAS','SBE','SAE','EBS','EAS','EBE','EAE','SDU','EDU','ECW','SCW','CONCURRENT']
+    INVERSION = {'SBS' => 'SAS','EAE' => 'EBE','SAS' => 'SBS','EBE' => 'EAE','SBE' => 'EAS','EAS' => 'SBE','SAE' => 'EBS','EBS' => 'SAE'}
+    
+    attr_reader :type, :reference, :range
+    
+    # @param [String] type
+    # @param [Reference] reference
+    # @param [Range] range
+    def initialize(type, reference, range)
+      @type = type
+      @reference = reference
+      if (range.is_a? HQMF::Value)
+        @range = HQMF::Range.new('IVL_PQ', range, range, nil)
+      else
+        @range = range
+      end
+    end
+    
+    def self.from_json(json)
+      type = json["type"] if json["type"]
+      reference = HQMF::Reference.new(json["reference"]) if json["reference"]
+      range = HQMF::Range.from_json(json["range"]) if json["range"]
+      
+      HQMF::TemporalReference.new(type,reference,range)
+    end
+    
+    
+    def to_json
+      x = nil
+      json = build_hash(self, [:type])
+      json[:reference] = @reference.to_json if @reference
+      json[:range] = @range.to_json if @range
+      json
+    end
+    
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+  end
+
+  class SubsetOperator
+    include HQMF::Conversion::Utilities
+    
+    TYPES = ['COUNT', 'FIRST', 'SECOND', 'THIRD', 'FOURTH', 'FIFTH', 'RECENT', 'LAST', 'MIN', 'MAX', 'DATEDIFF']
+    
+    attr_accessor :type, :value
+    # @param [String] type
+    # @param [Value] value
+    def initialize(type,value)
+      @type = type
+      if (value.is_a? HQMF::Value)
+        value.inclusive = true
+        @value = HQMF::Range.new('IVL_PQ',value,value,nil)
+      else
+        @value = value
+      end
+    end
+    
+    def self.from_json(json)
+      type = json["type"] if json["type"]
+      value = HQMF::Range.from_json(json["value"]) if json["value"]
+      
+      HQMF::SubsetOperator.new(type,value)
+    end
+    
+    
+    def to_json
+      x = nil
+      json = build_hash(self, [:type])
+      json[:value] = @value.to_json if @value
+      json
+    end
+    
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+  end
+
+  
+  # Represents a HQMF reference from a precondition to a data criteria
+  class Reference
+    include HQMF::Conversion::Utilities
+    attr_accessor :id
+    
+    # Create a new HQMF::Reference
+    # @param [String] id
+    def initialize(id)
+      @id = id
+    end
+    
+    def to_json
+      @id
+    end
+    
+    def ==(other)
+      check_equality(self,other)
+    end
+    
+  end
+  
+end