cqm-models 2.0.1 → 3.0.0

data/app/assets/javascripts/basetypes/Code.js

@@ -8,20 +8,17 @@ Code.prototype = Object.create(mongoose.SchemaType.prototype);
 
 Code.prototype.cast = (code) => {
   if (code != null) {
+    // return code if it doesn't even need casting
+    if (code.isCode) {
+      return code;
+    }
     // handles codes that have not yet been cast to a code and those that have already been cast to a code
-    if (code.code && (code.codeSystemOid || code.system)) {
-      if (typeof code.code === 'undefined') {
-        throw new Error(`Code: ${code} does not have a code`);
-      } else if (typeof code.codeSystemOid === 'undefined' && typeof code.system === 'undefined') {
-        throw new Error(`Code: ${code} does not have a system oid`);
-      }
-
-      const val = { code: code.code, codeSystemOid: code.codeSystemOid || code.system };
-
-      val.descriptor = (typeof code.descriptor !== 'undefined') ? code.descriptor : null;
+    if (code.code && code.system) {
+      const val = { code: code.code, system: code.system };
+      val.display = (typeof code.display !== 'undefined') ? code.display : null;
       val.version = (typeof code.version !== 'undefined') ? code.version : null;
 
-      return new cql.Code(val.code, val.codeSystemOid, val.version, val.descriptor);
+      return new cql.Code(val.code, val.system, val.version, val.display);
     }
     throw new Error(`Expected a code. Received ${code}.`);
   } else {

data/app/assets/javascripts/basetypes/DataElement.js

@@ -1,19 +1,19 @@
 const mongoose = require('mongoose/browser');
 const Code = require('./Code.js');
 const cql = require('cql-execution');
-const Id = require('../Id');
+const Identifier = require('../attributes/Identifier');
 
 const [Schema] = [mongoose.Schema];
 
 function DataElementSchema(add, options) {
   const extended = new Schema({
-    dataElementCodes: { type: [] },
+    dataElementCodes: { type: [Code] },
     description: { type: String },
     codeListId: { type: String },
     id: {
-      type: Id.IdSchema,
+      type: String,
       default() {
-        return new Id.Id({ value: (this._id ? this._id.toString() : mongoose.Types.ObjectId().toString()), namingSystem: null });
+        return this._id ? this._id.toString() : mongoose.Types.ObjectId().toString();
       },
     },
   }, options);
@@ -25,7 +25,12 @@ function DataElementSchema(add, options) {
   // Returns all of the codes on this data element in a format usable by
   // the cql-execution framework.
   extended.methods.getCode = function getCode() {
-    return this.dataElementCodes.map(code => new cql.Code(code.code, code.codeSystemOid, code.version, code.descriptor));
+    return this.dataElementCodes.map((code) => {
+      if (code.isCode) {
+        return code;
+      }
+      return new cql.Code(code.code, code.system, code.version, code.display);
+    });
   };
 
   // Return the first code on this data element in a format usable by
@@ -33,7 +38,10 @@ function DataElementSchema(add, options) {
   extended.methods.code = function code() {
     if (this.dataElementCodes && this.dataElementCodes[0]) {
       const qdmCode = this.dataElementCodes[0];
-      return new cql.Code(qdmCode.code, qdmCode.codeSystemOid, qdmCode.version, qdmCode.descriptor);
+      if (qdmCode.isCode) {
+        return qdmCode;
+      }
+      return new cql.Code(qdmCode.code, qdmCode.system, qdmCode.version, qdmCode.display);
     }
     return null;
   };

data/app/assets/javascripts/basetypes/Interval.js

@@ -15,9 +15,9 @@ Interval.prototype.cast = (interval) => {
 
   // Cast Low and High values to Quantities if it is a quantity
   if (casted.low && casted.low.unit && casted.low.value) {
-    casted.low = new cql.Quantity(casted.low);
+    casted.low = new cql.Quantity(casted.low.value, casted.low.unit);
     if (casted.high && casted.high.unit && casted.high.value) {
-      casted.high = new cql.Quantity(casted.high);
+      casted.high = new cql.Quantity(casted.high.value, casted.high.unit);
     }
     return casted;
   }

data/app/assets/javascripts/basetypes/QDMDate.js

@@ -0,0 +1,36 @@
+const mongoose = require('mongoose/browser');
+const cql = require('cql-execution');
+
+function QDMDate(key, options) {
+  mongoose.SchemaType.call(this, key, options, 'Date');
+}
+QDMDate.prototype = Object.create(mongoose.SchemaType.prototype);
+
+QDMDate.prototype.cast = (date) => {
+  if (date == null) {
+    return date;
+  }
+
+  // Already a CQL Date
+  if (date.isDate) {
+    return date;
+  }
+
+  // Object
+  if (typeof date === 'object') {
+    const keys = Object.keys(date);
+    if (keys.includes('year') && keys.includes('month') && keys.includes('day')) {
+      return new cql.Date(date.year, date.month, date.day);
+    }
+  }
+
+  // Date String
+  if (!cql.Date.parse(date)) {
+    throw new Error(`Date: ${date} is not a valid Date`);
+  } else {
+    return cql.Date.parse(date);
+  }
+};
+
+mongoose.Schema.Types.QDMDate = QDMDate;
+module.exports = QDMDate;

data/app/assets/javascripts/basetypes/Quantity.js

@@ -13,7 +13,7 @@ Quantity.prototype.cast = (quantity) => {
     throw new Error(`Quantity: ${quantity} does not have a unit`);
   }
 
-  return new cql.Quantity(quantity);
+  return new cql.Quantity(quantity.value, quantity.unit);
 };
 
 mongoose.Schema.Types.Quantity = Quantity;

data/app/assets/javascripts/basetypes/Ratio.js

@@ -13,7 +13,7 @@ Ratio.prototype.cast = (ratio) => {
     throw new Error(`Ratio: ${ratio} does not have a denominator`);
   }
 
-  return new cql.Ratio(ratio);
+  return new cql.Ratio(ratio.numerator, ratio.denominator);
 };
 
 mongoose.Schema.Types.Ratio = Ratio;

data/app/assets/javascripts/cqm/Provider.js

@@ -1,5 +1,4 @@
 const mongoose = require('mongoose/browser');
-const Id = require('../Id');
 
 const [Schema, String, Boolean] = [
   mongoose.Schema,
@@ -31,7 +30,6 @@ const ProviderSchema = new Schema({
   title: String,
   addresses: [AddressSchema],
   telecoms: [TelecomSchema],
-  ids: [Id.IdSchema],
 
 }, { id: false });
 

data/app/models/cqm/provider.rb

@@ -16,7 +16,7 @@ module CQM
 
     embeds_many :addresses
     embeds_many :telecoms
-    embeds_many :ids, class_name: 'QDM::Id'
+    embeds_many :ids, class_name: 'QDM::Identifier'
 
     def npi=(an_npi)
       cda_id_npi = ids.where(namingSystem: NPI_OID).first
@@ -24,7 +24,7 @@ module CQM
         cda_id_npi.value = an_npi
         cda_id_npi.save!
       else
-        ids << QDM::Id.new(namingSystem: NPI_OID, value: an_npi)
+        ids << QDM::Identifier.new(namingSystem: NPI_OID, value: an_npi)
       end
     end
 
@@ -34,7 +34,7 @@ module CQM
     end
 
     def tin=(a_tin)
-      ids << QDM::Id.new(namingSystem: TAX_ID_OID, value: a_tin)
+      ids << QDM::Identifier.new(namingSystem: TAX_ID_OID, value: a_tin)
     end
 
     def tin
@@ -48,7 +48,7 @@ module CQM
         cda_id_ccn.value = a_ccn
         cda_id_ccn.save!
       else
-        ids << QDM::Id.new(namingSystem: CCN_OID, value: a_ccn)
+        ids << QDM::Identifier.new(namingSystem: CCN_OID, value: a_ccn)
       end
     end
 

data/app/models/hqmfOid_to_datatype_map.json

@@ -1,4 +1,5 @@
 {
+  "2.16.840.1.113883.10.20.28.4.141": "RelatedPerson",
   "2.16.840.1.113883.10.20.28.4.61": "PhysicalExamOrder",
   "2.16.840.1.113883.10.20.28.4.130": "Participation",
   "2.16.840.1.113883.10.20.28.4.55": "PatientCharacteristicSex",
@@ -33,7 +34,6 @@
   "2.16.840.1.113883.10.20.28.4.28": "EncounterRecommended",
   "2.16.840.1.113883.10.20.28.4.67": "ProcedurePerformed",
   "2.16.840.1.113883.10.20.28.4.119": "AllergyIntolerance",
-  "2.16.840.1.113883.10.20.28.4.71": "ProviderCharacteristic",
   "22.16.840.1.113883.10.20.28.4.63": "PhysicalExamRecommended",
   "2.16.840.1.113883.10.20.28.4.54": "PatientCharacteristicBirthdate",
   "2.16.840.1.113883.10.20.28.4.120": "AdverseEvent",

data/app/models/models.rb

@@ -1,4 +1,4 @@
-# Base QDM module (generated from lib/generate_models.rb) for QDM 5.3
+# Base QDM module (generated from lib/generate_models.rb) for QDM 5.5
 module QDM
 end
 require 'mongoid'
@@ -7,17 +7,25 @@ require 'mongoid'
 require_relative 'model_finder'
 
 # Generated models that are dependencies for base types
-require_relative 'qdm/id'
+require_relative 'qdm/attributes/attribute'
+require_relative 'qdm/attributes/identifier'
 
 # base types
 require_relative 'qdm/basetypes/code'
 require_relative 'qdm/basetypes/data_element'
+require_relative 'qdm/basetypes/date'
 require_relative 'qdm/basetypes/interval'
 require_relative 'qdm/basetypes/quantity'
 require_relative 'qdm/basetypes/ratio'
-require_relative 'qdm/attributes/attribute'
 require_relative 'qdm/attributes/facility_location'
 require_relative 'qdm/attributes/component'
+require_relative 'qdm/attributes/entity'
+require_relative 'qdm/attributes/care_partner'
+require_relative 'qdm/attributes/diagnosis_component'
+require_relative 'qdm/attributes/organization'
+require_relative 'qdm/attributes/patient_entity'
+require_relative 'qdm/attributes/practitioner'
+require_relative 'qdm/attributes/result_component'
 
 # Tacoma-specific models
 require_relative 'cqm/measure'
@@ -38,6 +46,7 @@ require_relative '../../lib/generate_patients'
 
 # Generated models
 require_relative 'qdm/patient'
+require_relative 'qdm/related_person'
 require_relative 'qdm/physical_exam_order'
 require_relative 'qdm/participation'
 require_relative 'qdm/patient_characteristic_sex'
@@ -58,7 +67,6 @@ require_relative 'qdm/device_order'
 require_relative 'qdm/diagnostic_study_performed'
 require_relative 'qdm/intervention_order'
 require_relative 'qdm/family_history'
-require_relative 'qdm/result_component'
 require_relative 'qdm/medication_active'
 require_relative 'qdm/laboratory_test_order'
 require_relative 'qdm/diagnostic_study_order'
@@ -73,7 +81,6 @@ require_relative 'qdm/encounter_order'
 require_relative 'qdm/encounter_recommended'
 require_relative 'qdm/procedure_performed'
 require_relative 'qdm/allergy_intolerance'
-require_relative 'qdm/provider_characteristic'
 require_relative 'qdm/physical_exam_recommended'
 require_relative 'qdm/patient_characteristic_birthdate'
 require_relative 'qdm/adverse_event'

data/app/models/qdm/adverse_event.rb

@@ -4,13 +4,14 @@ module QDM
     include Mongoid::Document
     embedded_in :patient
     field :authorDatetime, type: DateTime
-    field :relevantPeriod, type: QDM::Interval
+    field :relevantDatetime, type: DateTime
     field :severity, type: QDM::Code
     field :facilityLocation, type: QDM::FacilityLocation
     field :type, type: QDM::Code
+    embeds_one :recorder, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Adverse Event'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.120'
     field :qdmCategory, type: String, default: 'adverse_event'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/allergy_intolerance.rb

@@ -7,10 +7,11 @@ module QDM
     field :prevalencePeriod, type: QDM::Interval
     field :type, type: QDM::Code
     field :severity, type: QDM::Code
+    embeds_one :recorder, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Allergy/Intolerance'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.119'
     field :qdmCategory, type: String, default: 'allergy'
     field :qdmStatus, type: String, default: 'intolerance'
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/assessment_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: 'Assessment, Order'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.131'
     field :qdmCategory, type: String, default: 'assessment'
     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/assessment_performed.rb

@@ -4,16 +4,19 @@ 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 :method, type: QDM::Code
     field :result
     field :components, type: Array
-    embeds_many :relatedTo, class_name: 'QDM::Id'
+    field :relatedTo, type: Array
+    embeds_one :performer, class_name: 'QDM::Entity'
     field :qdmTitle, type: String, default: 'Assessment, Performed'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.117'
     field :qdmCategory, type: String, default: 'assessment'
     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/assessment_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: 'Assessment, Recommended'
     field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.4.118'
     field :qdmCategory, type: String, default: 'assessment'
     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/attributes/care_partner.rb

@@ -0,0 +1,8 @@
+module QDM
+  # app/models/qdm/care_partner.rb
+  class CarePartner < Entity
+    include Mongoid::Document
+    embedded_in :data_element
+    field :relationship, type: QDM::Code
+  end
+end

data/app/models/qdm/attributes/component.rb

@@ -4,6 +4,6 @@ module QDM
     include Mongoid::Document
     field :code, type: QDM::Code
     field :result
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/attributes/diagnosis_component.rb

@@ -0,0 +1,10 @@
+module QDM
+  # app/models/qdm/diagnosis_component.rb
+  class DiagnosisComponent < Attribute
+    include Mongoid::Document
+    field :code, type: QDM::Code
+    field :presentOnAdmissionIndicator, type: QDM::Code
+    field :rank, type: Integer
+    field :qdmVersion, type: String, default: '5.5'
+  end
+end

data/app/models/qdm/attributes/entity.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/entity.rb
+  class Entity < Attribute
+    include Mongoid::Document
+    embedded_in :data_element
+    field :id, type: String
+    embeds_one :identifier, class_name: 'QDM::Identifier'
+    field :qdmVersion, type: String, default: '5.5'
+    def initialize(options = {})
+      super(options)
+      # default id to the mongo ObjectId for this DataElement if it isnt already defined
+      self.id = _id.to_s unless id?
+    end
+  end
+end

data/app/models/qdm/attributes/facility_location.rb

@@ -4,6 +4,6 @@ module QDM
     include Mongoid::Document
     field :code, type: QDM::Code
     field :locationPeriod, type: QDM::Interval
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/{id.rb → attributes/identifier.rb}

@@ -1,10 +1,9 @@
 module QDM
-  # app/models/qdm/id.rb
-  class Id
+  # app/models/qdm/identifier.rb
+  class Identifier < Attribute
     include Mongoid::Document
-    embedded_in :data_element
     field :namingSystem, type: String
     field :value, type: String
-    field :qdmVersion, type: String, default: '5.4'
+    field :qdmVersion, type: String, default: '5.5'
   end
 end

data/app/models/qdm/attributes/organization.rb

@@ -0,0 +1,8 @@
+module QDM
+  # app/models/qdm/organization.rb
+  class Organization < Entity
+    include Mongoid::Document
+    embedded_in :data_element
+    field :type, type: QDM::Code
+  end
+end

data/app/models/qdm/attributes/patient_entity.rb

@@ -0,0 +1,7 @@
+module QDM
+  # app/models/qdm/patient_entity.rb
+  class PatientEntity < Entity
+    include Mongoid::Document
+    embedded_in :data_element
+  end
+end

data/app/models/qdm/attributes/practitioner.rb

@@ -0,0 +1,10 @@
+module QDM
+  # app/models/qdm/practitioner.rb
+  class Practitioner < Entity
+    include Mongoid::Document
+    embedded_in :data_element
+    field :role, type: QDM::Code
+    field :specialty, type: QDM::Code
+    field :qualification, type: QDM::Code
+  end
+end