cqm-models 0.7.2

data/app/models/qdm/diagnostic_study_performed.rb

@@ -0,0 +1,21 @@
+module QDM
+  # app/models/qdm/diagnostic_study_performed.rb
+  class DiagnosticStudyPerformed < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :reason, type: QDM::Code
+    field :result
+    field :resultDatetime, type: DateTime
+    field :status, type: QDM::Code
+    field :method, type: QDM::Code
+    field :facilityLocation, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :components, type: Array
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.23'
+    field :category, type: String, default: 'diagnostic_study'
+    field :qdmStatus, type: String, default: 'performed'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/diagnostic_study_recommended.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/diagnostic_study_recommended.rb
+  class DiagnosticStudyRecommended < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :method, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.24'
+    field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.19'
+    field :category, type: String, default: 'diagnostic_study'
+    field :qdmStatus, type: String, default: 'recommended'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/encounter_order.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/encounter_order.rb
+  class EncounterOrder < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :facilityLocation, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.27'
+    field :category, type: String, default: 'encounter'
+    field :qdmStatus, type: String, default: 'order'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/encounter_performed.rb

@@ -0,0 +1,20 @@
+module QDM
+  # app/models/qdm/encounter_performed.rb
+  class EncounterPerformed < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :admissionSource, type: QDM::Code
+    field :relevantPeriod, type: QDM::Interval
+    field :dischargeDisposition, type: QDM::Code
+    field :facilityLocations, type: Array
+    field :diagnoses, type: Array
+    field :principalDiagnosis, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :lengthOfStay, type: QDM::Quantity
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.5'
+    field :category, type: String, default: 'encounter'
+    field :qdmStatus, type: String, default: 'performed'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/encounter_recommended.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/encounter_recommended.rb
+  class EncounterRecommended < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :facilityLocation, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.28'
+    field :category, type: String, default: 'encounter'
+    field :qdmStatus, type: String, default: 'recommended'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/facility_location.rb

@@ -0,0 +1,10 @@
+module QDM
+  # app/models/qdm/facility_location.rb
+  class FacilityLocation < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :code, type: QDM::Code
+    field :locationPeriod, type: QDM::Interval
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/family_history.rb

@@ -0,0 +1,13 @@
+module QDM
+  # app/models/qdm/family_history.rb
+  class FamilyHistory < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relationship, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.111'
+    field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.12'
+    field :category, type: String, default: 'family_history'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/id.rb

@@ -0,0 +1,10 @@
+module QDM
+  # app/models/qdm/id.rb
+  class Id < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :namingSystem, type: String
+    field :value, type: String
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/immunization_administered.rb

@@ -0,0 +1,18 @@
+module QDM
+  # app/models/qdm/immunization_administered.rb
+  class ImmunizationAdministered < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :route, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.112'
+    field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.140'
+    field :category, type: String, default: 'immunization'
+    field :qdmStatus, type: String, default: 'administered'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/immunization_order.rb

@@ -0,0 +1,18 @@
+module QDM
+  # app/models/qdm/immunization_order.rb
+  class ImmunizationOrder < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :activeDatetime, type: DateTime
+    field :authorDatetime, type: DateTime
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :reason, type: QDM::Code
+    field :route, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.113'
+    field :category, type: String, default: 'immunization'
+    field :qdmStatus, type: String, default: 'order'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/intervention_order.rb

@@ -0,0 +1,14 @@
+module QDM
+  # app/models/qdm/intervention_order.rb
+  class InterventionOrder < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.35'
+    field :category, type: String, default: 'intervention'
+    field :qdmStatus, type: String, default: 'order'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/intervention_performed.rb

@@ -0,0 +1,17 @@
+module QDM
+  # app/models/qdm/intervention_performed.rb
+  class InterventionPerformed < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :reason, type: QDM::Code
+    field :result
+    field :status, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.36'
+    field :category, type: String, default: 'intervention'
+    field :qdmStatus, type: String, default: 'performed'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/intervention_recommended.rb

@@ -0,0 +1,14 @@
+module QDM
+  # app/models/qdm/intervention_recommended.rb
+  class InterventionRecommended < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.37'
+    field :category, type: String, default: 'intervention'
+    field :qdmStatus, type: String, default: 'recommended'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/laboratory_test_order.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/laboratory_test_order.rb
+  class LaboratoryTestOrder < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :method, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.41'
+    field :category, type: String, default: 'laboratory_test'
+    field :qdmStatus, type: String, default: 'order'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/laboratory_test_performed.rb

@@ -0,0 +1,21 @@
+module QDM
+  # app/models/qdm/laboratory_test_performed.rb
+  class LaboratoryTestPerformed < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :status, type: QDM::Code
+    field :method, type: QDM::Code
+    field :result
+    field :resultDatetime, type: DateTime
+    field :reason, type: QDM::Code
+    field :referenceRange, type: QDM::Interval
+    field :negationRationale, type: QDM::Code
+    field :components, type: Array
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.42'
+    field :category, type: String, default: 'laboratory_test'
+    field :qdmStatus, type: String, default: 'performed'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/laboratory_test_recommended.rb

@@ -0,0 +1,15 @@
+module QDM
+  # app/models/qdm/laboratory_test_recommended.rb
+  class LaboratoryTestRecommended < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :method, type: QDM::Code
+    field :reason, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.43'
+    field :category, type: String, default: 'laboratory_test'
+    field :qdmStatus, type: String, default: 'recommended'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/medication_active.rb

@@ -0,0 +1,16 @@
+module QDM
+  # app/models/qdm/medication_active.rb
+  class MedicationActive < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :relevantPeriod, type: QDM::Interval
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :frequency, type: QDM::Code
+    field :route, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.44'
+    field :category, type: String, default: 'medication'
+    field :qdmStatus, type: String, default: 'active'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/medication_administered.rb

@@ -0,0 +1,19 @@
+module QDM
+  # app/models/qdm/medication_administered.rb
+  class MedicationAdministered < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :frequency, type: QDM::Code
+    field :route, type: QDM::Code
+    field :reason, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.45'
+    field :category, type: String, default: 'medication'
+    field :qdmStatus, type: String, default: 'administered'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/medication_discharge.rb

@@ -0,0 +1,18 @@
+module QDM
+  # app/models/qdm/medication_discharge.rb
+  class MedicationDischarge < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :refills, type: Integer
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :frequency, type: QDM::Code
+    field :route, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.48'
+    field :category, type: String, default: 'medication'
+    field :qdmStatus, type: String, default: 'discharge'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/medication_dispensed.rb

@@ -0,0 +1,19 @@
+module QDM
+  # app/models/qdm/medication_dispensed.rb
+  class MedicationDispensed < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :refills, type: Integer
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :frequency, type: QDM::Code
+    field :route, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.49'
+    field :category, type: String, default: 'medication'
+    field :qdmStatus, type: String, default: 'dispensed'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/medication_order.rb

@@ -0,0 +1,22 @@
+module QDM
+  # app/models/qdm/medication_order.rb
+  class MedicationOrder < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :activeDatetime, type: DateTime
+    field :relevantPeriod, type: QDM::Interval
+    field :authorDatetime, type: DateTime
+    field :refills, type: Integer
+    field :dosage, type: QDM::Quantity
+    field :supply, type: QDM::Quantity
+    field :frequency, type: QDM::Code
+    field :route, type: QDM::Code
+    field :method, type: QDM::Code
+    field :reason, type: QDM::Code
+    field :negationRationale, type: QDM::Code
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.51'
+    field :category, type: String, default: 'medication'
+    field :qdmStatus, type: String, default: 'order'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/participation.rb

@@ -0,0 +1,9 @@
+module QDM
+  # app/models/qdm/participation.rb
+  class Participation < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :participationPeriod, type: QDM::Interval
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/patient.rb

@@ -0,0 +1,201 @@
+module QDM
+  # app/models/qdm/patient.rb
+  class Patient
+    include Mongoid::Document
+    field :birthDatetime, type: DateTime
+    field :qdmVersion, type: String, default: '5.3'
+    field :givenNames, type: Array
+    field :familyName, type: String
+    field :bundleId, type: String
+
+    # These are the "data criteria", or QDM datatype elements that exist on a
+    # patient.
+    embeds_many :dataElements, class_name: 'QDM::DataElement'
+
+    # This field is for application specific information only. If both Bonnie
+    # Cypress use a common field, it should be made a field on this model,
+    # and not put into extendedData.
+    field :extendedData, type: Hash
+
+    # Returns an array of elements that exist on this patient, that
+    # match the given HQMF data criteria OID.
+    def get_by_hqmf_oid(hqmf_oid)
+      dataElements.where(hqmfOid: hqmf_oid) || []
+    end
+
+    # Returns an array of elements that exist on this patient, that
+    # match the given QRDA data criteria OID.
+    def get_by_qrda_oid(qrda_oid)
+      dataElements.where(qrdaOid: qrda_oid) || []
+    end
+
+    # Returns an array of elements that exist on this patient. Optionally
+    # takes a category and/or, which returns all elements of that QDM
+    # category. Example: patient.get_data_elements('encounters')
+    # will return all Encounter QDM data types active on the patient.
+    def get_data_elements(category = nil, status = nil)
+      if category && status
+        dataElements.where(category: category, qdmStatus: status) || []
+      elsif category
+        dataElements.where(category: category) || []
+      else
+        dataElements || []
+      end
+    end
+
+    # Helper method; returns adverse_event data element types on this patient.
+    def adverse_events
+      get_data_elements('adverse_event')
+    end
+
+    # Helper method; returns allergy data element types on this patient.
+    def allergies
+      get_data_elements('allergy')
+    end
+
+    # Helper method; returns assessment data element types on this patient.
+    def assessments
+      get_data_elements('assessment')
+    end
+
+    # Helper method; returns care_experience data element types on this patient.
+    def care_experiences
+      get_data_elements('care_experience')
+    end
+
+    # Helper method; returns care_goal data element types on this patient.
+    def care_goals
+      get_data_elements('care_goal')
+    end
+
+    # Helper method; returns communication data element types on this patient.
+    def communications
+      get_data_elements('communication')
+    end
+
+    # Helper method; returns condition data element types on this patient.
+    def conditions
+      get_data_elements('condition')
+    end
+
+    # Helper method; returns device data element types on this patient.
+    def devices
+      get_data_elements('device')
+    end
+
+    # Helper method; returns diagnostic_study data element types on this patient.
+    def diagnostic_studies
+      get_data_elements('diagnostic_study')
+    end
+
+    # Helper method; returns encounter data element types on this patient.
+    def encounters
+      get_data_elements('encounter')
+    end
+
+    # Helper method; returns family_history data element types on this patient.
+    def family_history
+      get_data_elements('family_history')
+    end
+
+    # Helper method; returns functional_status data element types on this patient.
+    def functional_statuses
+      get_data_elements('functional_status')
+    end
+
+    # Helper method; returns immunization data element types on this patient.
+    def immunizations
+      get_data_elements('immunization')
+    end
+
+    # Helper method; returns intervention data element types on this patient.
+    def interventions
+      get_data_elements('intervention')
+    end
+
+    # Helper method; returns laboratory_test data element types on this patient.
+    def laboratory_tests
+      get_data_elements('laboratory_test')
+    end
+
+    # Helper method; returns medical_equipment data element types on this patient.
+    def medical_equipment
+      get_data_elements('medical_equipment')
+    end
+
+    # Helper method; returns medication data element types on this patient.
+    def medications
+      get_data_elements('medication')
+    end
+
+    # Helper method; returns physical_exam data element types on this patient.
+    def physical_exams
+      get_data_elements('physical_exam')
+    end
+
+    # Helper method; returns preference data element types on this patient.
+    def preferences
+      get_data_elements('preference')
+    end
+
+    # Helper method; returns provider_characteristic data element types on this patient.
+    def provider_characteristics
+      get_data_elements('provider_characteristic')
+    end
+
+    # Helper method; returns procedure data element types on this patient.
+    def procedures
+      get_data_elements('procedure')
+    end
+
+    # Helper method; returns result data element types on this patient.
+    def results
+      get_data_elements('result')
+    end
+
+    # Helper method; returns risk_category_assessment data element types on this patient.
+    def risk_category_assessments
+      get_data_elements('risk_category_assessment')
+    end
+
+    # Helper method; returns social_history data element types on this patient.
+    def social_history
+      get_data_elements('social_history')
+    end
+
+    # Helper method; returns substance data element types on this patient.
+    def substances
+      get_data_elements('substance')
+    end
+
+    # Helper method; returns symptom data element types on this patient.
+    def symptoms
+      get_data_elements('symptom')
+    end
+
+    # Helper method; returns system_characteristic data element types on this patient.
+    def system_characteristics
+      get_data_elements('system_characteristic')
+    end
+
+    # Helper method; returns transfer data element types on this patient.
+    def transfers
+      get_data_elements('transfer')
+    end
+
+    # Helper method; returns vital_sign data element types on this patient.
+    def vital_signs
+      get_data_elements('vital_sign')
+    end
+
+    # Return the Mongo id.
+    def id
+      _id
+    end
+
+    # Include '_type' in any JSON output. This is necessary for deserialization.
+    def to_json(options = nil)
+      serializable_hash(methods: :_type).to_json(options)
+    end
+  end
+end

data/app/models/qdm/patient_care_experience.rb

@@ -0,0 +1,11 @@
+module QDM
+  # app/models/qdm/patient_care_experience.rb
+  class PatientCareExperience < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.52'
+    field :category, type: String, default: 'care_experience'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/patient_characteristic.rb

@@ -0,0 +1,11 @@
+module QDM
+  # app/models/qdm/patient_characteristic.rb
+  class PatientCharacteristic < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :authorDatetime, type: DateTime
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.53'
+    field :category, type: String, default: 'patient_characteristic'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/patient_characteristic_birthdate.rb

@@ -0,0 +1,12 @@
+module QDM
+  # app/models/qdm/patient_characteristic_birthdate.rb
+  class PatientCharacteristicBirthdate < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :birthDatetime, type: DateTime
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.54'
+    field :category, type: String, default: 'patient_characteristic'
+    field :qdmStatus, type: String, default: 'birthdate'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/patient_characteristic_clinical_trial_participant.rb

@@ -0,0 +1,14 @@
+module QDM
+  # app/models/qdm/patient_characteristic_clinical_trial_participant.rb
+  class PatientCharacteristicClinicalTrialParticipant < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :reason, type: QDM::Code
+    field :relevantPeriod, type: QDM::Interval
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.6'
+    field :qrdaOid, type: String, default: '2.16.840.1.113883.10.20.24.3.51'
+    field :category, type: String, default: 'patient_characteristic'
+    field :qdmStatus, type: String, default: 'clinical_trial_participant'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end

data/app/models/qdm/patient_characteristic_ethnicity.rb

@@ -0,0 +1,11 @@
+module QDM
+  # app/models/qdm/patient_characteristic_ethnicity.rb
+  class PatientCharacteristicEthnicity < DataElement
+    include Mongoid::Document
+    embedded_in :patient
+    field :hqmfOid, type: String, default: '2.16.840.1.113883.10.20.28.3.56'
+    field :category, type: String, default: 'patient_characteristic'
+    field :qdmStatus, type: String, default: 'ethnicity'
+    field :qdmVersion, type: String, default: '5.3'
+  end
+end