hquery-patient-api 1.0.4 → 1.1.0

data/app/assets/javascripts/encounter.js.coffee

@@ -5,7 +5,7 @@ this.hQuery ||= {}
 
 
 # =require core.coffee
-	
+
 ###*
 An Encounter is an interaction, regardless of the setting, between a patient and a
 practitioner who is vested with primary responsibility for diagnosing, evaluating,
@@ -16,7 +16,7 @@ patient at a given contact, exercising independent judgment.
 @class An Encounter is an interaction, regardless of the setting, between a patient and a
 practitioner
 @augments hQuery.CodedEntry
-@exports Encounter as hQuery.Encounter 
+@exports Encounter as hQuery.Encounter
 ###
 class hQuery.Encounter extends hQuery.CodedEntry
   constructor: (@json) ->
@@ -24,19 +24,19 @@ class hQuery.Encounter extends hQuery.CodedEntry
     @_admitTime = hQuery.dateFromUtcSeconds @json['admitTime'] if @json['admitTime']
     @_dischargeTime = hQuery.dateFromUtcSeconds @json['dischargeTime'] if @json['dischargeTime']
     @_facility = new hQuery.Facility @json['facility'] if @json['facility']
-  	
+
   ###*
   @returns {String}
   ####
   dischargeDisposition: -> @json['dischargeDisposition']
-  
+
   ###*
   A code indicating the priority of the admission (e.g., Emergency, Urgent, Elective, et cetera) from
   National Uniform Billing Committee (NUBC)
   @returns {CodedValue}
   ###
   admitType: -> hQuery.createCodedValue @json['admitType']
-  
+
   ###*
   Date and time at which the patient was admitted for the encounter
   @returns {Date}
@@ -48,12 +48,12 @@ class hQuery.Encounter extends hQuery.CodedEntry
   @returns {Date}
   ###
   dischargeTime: -> @_dischargeTime
-  
+
   ###*
   @returns {hQuery.Actor}
   ###
   performer: -> new hQuery.Actor @json['performer'] if @json['performer']
-  
+
   ###*
   @returns {hQuery.Organization}
   ###
@@ -65,7 +65,7 @@ class hQuery.Encounter extends hQuery.CodedEntry
   @returns {hQuery.CodedEntry}
   ###
   reasonForVisit: -> new hQuery.CodedEntry @json['reason'] if @json['reason']
-  
+
   ###*
   @returns {Integer}
   ###
@@ -73,13 +73,41 @@ class hQuery.Encounter extends hQuery.CodedEntry
     return 0 unless @startDate()? && @endDate()?
     Math.floor((@endDate() - @startDate()) / (1000 * 60 * 60 * 24))
 
+  ###*
+  @returns {CodedValue}
+  ###
+  method: ->  new hQuery.createCodedValue @json['method']
 
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: ->  new hQuery.createCodedValue @json['reaction']
   ###*
   @returns {CodedValue}
   ###
   transferTo: -> hQuery.createCodedValue @json['transferTo']
-  
+
   ###*
   @returns {CodedValue}
   ###
   transferFrom: -> hQuery.createCodedValue @json['transferFrom']
+
+  ###*
+  @returns {CodedValue|CodedValue[]}
+  ###
+  diagnosis: ->
+    if @json['diagnosis']?['codes']
+      # Support for diagnosis with multiple codes
+      hQuery.createCodedValues @json['diagnosis']['codes']
+    else
+      hQuery.createCodedValue @json['diagnosis']
+
+  ###*
+  @returns {CodedValue|CodedValue[]}
+  ###
+  principalDiagnosis: ->
+    if @json['principalDiagnosis']?['codes']
+      # Support for principal diagnosis with multiple codes
+      hQuery.createCodedValues @json['principalDiagnosis']['codes']
+    else
+      hQuery.createCodedValue @json['principalDiagnosis']

data/app/assets/javascripts/familyhistory.js.coffee

@@ -0,0 +1,26 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+This represents all  family history.
+@class
+@augments hQuery.CodedEntry
+@exports FamilyHistory as hQuery.FamilyHistory
+###
+class hQuery.FamilyHistory extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+
+  ###*
+  @returns {CodedValue}
+  ###
+  relationshipToPatient: -> hQuery.createCodedValue @json['relationshipToPatient']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  onsetAge: -> new hQuery.Scalar @json['onsetAge']

data/app/assets/javascripts/functionalstatus.js.coffee

@@ -5,7 +5,7 @@ this.hQuery ||= {}
 
 # =require core.coffee
 ###*
-This class can be used to represnt a functional status for a patient. Currently,
+This class can be used to represent a functional status for a patient. Currently,
 it is not a very close representation of functional status as it is represented
 in the HL7 CCD, HITSP C32 or Consolidated CDA.
 
@@ -14,19 +14,19 @@ using either a condition or result. Having "mixed" types of entries in a section
 is currently not well supported in the existing Record class
 
 Additionally, there is a mismatch between the data needed to calculate Stage 2
-Meaningful Use Quailty Measures and the data contained in patient summary
+Meaningful Use Quality Measures and the data contained in patient summary
 standards. The CQMs are checking to see if a functional status represented by
 a result was patient supplied. Right now, results do not have a source, and
 even if we were to use Provider as a source, it would need to be extended
 to support patients.
 
-To avoid this, the patient sumamry style functional status has been "flattened"
+To avoid this, the patient summary style functional status has been "flattened"
 into this class. This model supports the information needed to calculate
 Stage 2 MU CQMs. If importers are created from C32 or CCDA, the information
 can be stored here, but it will be a lossy transformation.
 @class
 @augments hQuery.CodedEntry
-@exports FunctionalStatus as hQuery.FunctionalStatus 
+@exports FunctionalStatus as hQuery.FunctionalStatus
 ###
 class hQuery.FunctionalStatus extends hQuery.CodedEntry
   constructor: (@json) ->
@@ -44,4 +44,13 @@ class hQuery.FunctionalStatus extends hQuery.CodedEntry
   ###
   source: ->
     hQuery.createCodedValue @json["source"]
-  
+
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: -> hQuery.createCodedValue @json['reaction']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  method: -> hQuery.createCodedValue @json['method']

data/app/assets/javascripts/immunization.js.coffee

@@ -21,7 +21,7 @@ class hQuery.NoImmunization extends hQuery.CodedValue
   OUT_OF_STOCK = "OSTOCK"
   PAT_OBJ = "PATOBJ"
   PHIL_OBJ = "PHILISOP"
-  REL_OBJ = "RELIG"  
+  REL_OBJ = "RELIG"
   VAC_EFF = "VACEFF"
   VAC_SAFETY = "VACSAF"
 
@@ -44,22 +44,22 @@ class hQuery.NoImmunization extends hQuery.CodedValue
   @returns {Boolean}
   ###
   isPatObj: -> @c is PAT_OBJ
-	
+
   ###*
   @returns {Boolean}
   ###
-  isPhilisop: -> @c is PHIL_OBJ	
-  
+  isPhilisop: -> @c is PHIL_OBJ
+
   ###*
   @returns {Boolean}
   ###
   isRelig: -> @c is REL_OBJ
-  
+
   ###*
   @returns {Boolean}
   ###
   isVacEff: -> @c is VAC_EFF
-  
+
   ###*
   @returns {Boolean}
   ###
@@ -74,37 +74,37 @@ class hQuery.NoImmunization extends hQuery.CodedValue
 class hQuery.Immunization extends hQuery.CodedEntry
   constructor: (@json) ->
     super(@json)
-   
+
   ###*
-  @returns{hQuery.Scalar} 
+  @returns{hQuery.Scalar}
   ###
   medicationSeriesNumber: ->  new hQuery.Scalar @json['medicationSeriesNumber'] if  @json['medicationSeriesNumber']
-  
+
   ###*
   @returns{hQuery.MedicationInformation}
   ###
   medicationInformation: ->new hQuery.MedicationInformation @json
-  
+
   ###*
   @returns{Date} Date immunization was administered
   ###
   administeredDate: -> dateFromUtcSeconds @json['administeredDate']
-  
+
   ###*
   @returns{hQuery.Actor} Performer of immunization
   ###
   performer:-> new hQuery.Actor @json['performer'] if @json['performer']
-  
+
   ###*
   @returns {comment} human readable description of event
   ###
   comment: -> @json['comment']
-  
+
   ###*
   @returns {Boolean} whether the immunization has been refused by the patient.
   ###
   refusalInd: -> @json['negationInd']
-  
+
   ###*
   NoImmunzation as defined by value set 2.16.840.1.113883.1.11.19717
   The terms come from Health Level Seven (HL7) Version 3.0 Vocabulary and are managed by HL7
@@ -112,4 +112,9 @@ class hQuery.Immunization extends hQuery.CodedEntry
   @returns {hQuery.NoImmunization}   Used to indicate reason an immunization was not administered.
   ###
   refusalReason: -> new hQuery.NoImmunization @json['negationReason']?['code'], @json['negationReason']?['code_system']
- 
+
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: -> new hQuery.createCodedValue @json['reaction']
+

data/app/assets/javascripts/languages.js.coffee

@@ -6,24 +6,20 @@ this.hQuery ||= {}
 
 # =require core.coffee
 ###*
-@class 
+@class
 @augments hQuery.CodedEntry
 @exports Language as hQuery.Language
 ###
 class hQuery.Language extends hQuery.CodedEntry
   constructor: (@json) ->
     super(@json)
-  
+
   ###*
   @returns {hQuery.CodedValue}
   ###
   modeCode: -> hQuery.createCodedValue @json['modeCode']
-  
+
   ###*
   @returns {String}
   ###
   preferenceIndicator: -> @json['preferenceIndicator']
-
-    
-    
-    

data/app/assets/javascripts/medicalequipment.js.coffee

@@ -14,11 +14,11 @@ The template identifier for this section is 2.16.840.1.113883.3.88.11.83.128
 C83-[CT-128-1] This section shall conform to the HL7 CCD section, and shall contain a templateId element whose root attribute is 2.16.840.1.113883.10.20.1.7.
 C83-[CT-128-2] This section SHALL conform to the IHE Medical Devices Section, and shall contain a templateId element whose root attribute is 1.3.6.1.4.1.19376.1.5.3.1.1.5.3.5
 
-@exports MedicalEquipment as hQuery.MedicalEquipment 
+@exports MedicalEquipment as hQuery.MedicalEquipment
 @augments hQuery.CodedEntry
-###  
+###
 class hQuery.MedicalEquipment extends hQuery.CodedEntry
-  
+
   constructor: (@json) ->
     super(@json)
 
@@ -27,6 +27,29 @@ class hQuery.MedicalEquipment extends hQuery.CodedEntry
   ###
   anatomicalStructure: -> hQuery.createCodedValue @json['anatomicalStructure']
 
+  ###*
+  @returns {CodedValue}
+  ###
+  anatomicalApproach: -> new hQuery.createCodedValue @json['anatomicalApproach']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  anatomicalLocation: ->
+    #backwards compatibility with older patient records.  anatomicalStructure was used for anatomicalLocation
+    at = @json['anatomicalLocation']
+    if at? then new hQuery.CodedValue(at) else @anatomicalStructure()
+
+  ###*
+  @returns {CodedValue}
+  ###
+  method: ->  new hQuery.createCodedValue @json['method']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: ->  new hQuery.createCodedValue @json['reaction']
+
   ###*
   @returns {Date} The actual or intended removal time of the device.
   ###

data/app/assets/javascripts/medication.js.coffee

@@ -38,11 +38,11 @@ class hQuery.AdministrationTiming
   @returns {hQuery.Scalar}
   ###
   period: -> new hQuery.Scalar @json['period'] if @json['period']
-  
+
   ###*
-  Indicates whether it is the interval (time between dosing), or frequency 
-  (number of doses in a time period) that is important. If instititutionSpecified is not 
-  present or is set to false, then the time between dosing is important (every 8 hours). 
+  Indicates whether it is the interval (time between dosing), or frequency
+  (number of doses in a time period) that is important. If instititutionSpecified is not
+  present or is set to false, then the time between dosing is important (every 8 hours).
   If true, then the frequency of administration is important (e.g., 3 times per day).
   @returns {Boolean}
   ###
@@ -54,7 +54,7 @@ class hQuery.AdministrationTiming
 ###
 class hQuery.DoseRestriction
   constructor: (@json) ->
-  numerator: -> new hQuery.Scalar @json['numerator'] if @json['numerator'] 
+  numerator: -> new hQuery.Scalar @json['numerator'] if @json['numerator']
   denominator: -> new hQuery.Scalar @json['denominator'] if @json['denominator']
 
 
@@ -78,7 +78,7 @@ class hQuery.Fulfillment
 ###
 class hQuery.OrderInformation
   constructor: (@json) ->
-  
+
   orderNumber: -> @json['orderNumber']
   fills: -> @json['fills']
   quantityOrdered: -> new hQuery.Scalar @json['quantityOrdered'] if @json['quantityOrdered']
@@ -153,7 +153,7 @@ class hQuery.StatusOfMedication extends hQuery.CodedValue
 class hQuery.Medication  extends hQuery.CodedEntry
   constructor: (@json) ->
     super(@json)
-  
+
   ###*
   @returns {String}
   ####
@@ -173,11 +173,39 @@ class hQuery.Medication  extends hQuery.CodedEntry
   ###
   indicateMedicationStop: -> hQuery.dateFromUtcSeconds @json['end_time']
 
+
+  ###*
+  @returns {Date}
+  ###
+  activeDateTime: -> hQuery.dateFromUtcSeconds @json['active_datetime']  if @json['active_datetime']
+
+  ###*
+  @returns {Date}
+  ###
+  signedDateTime: -> hQuery.dateFromUtcSeconds @json['signed_datetime']  if @json['signed_datetime']
+
+
   administrationTiming: -> new hQuery.AdministrationTiming @json['administrationTiming'] if @json['administrationTiming']
 
+  ###*
+  This is used for Medicaton, Order. It is the total number of times a dose of a particular
+  medication can be administered. This, coupled with the administrationTiming will
+  give the cumulative medication duration.
+  E.g.
+    allowedAdministrations = 90 doses
+    administrationTiming = 1 dose / 12 hours
+    cumulativeMedicationDuration = allowedAdministrations / administrationTiming * (time conversion)
+    cumulativeMedicationDuration = (90 doses) * (12 hours)/(1 dose) * (1 day)/(24 hours) = 45 days
+  Medication, Order can't use fulfillmentHistory because the fulfillment of the 
+  medication has not yet happened.
+  This corresponds to 'repeatNumber' in the QRDA representation
+  @returns {Integer}
+  ###
+  allowedAdministrations: -> @json['allowedAdministrations']
+
   ###*
   @returns {CodedValue}  Contains routeCode or adminstrationUnitCode information.
-    Route code shall have a a value drawn from FDA route of adminstration,
+    Route code shall have a a value drawn from FDA route of administration,
     and indicates how the medication is received by the patient.
     See http://www.fda.gov/Drugs/DevelopmentApprovalProcess/UCM070829
     The administration unit code shall have a value drawn from the FDA
@@ -188,15 +216,27 @@ class hQuery.Medication  extends hQuery.CodedEntry
   route: -> hQuery.createCodedValue @json['route']
 
   ###*
-  @returns {hQuery.Scalar} the dose
+  @returns {Hash} with two keys: units and scalar
   ###
-  dose: -> new hQuery.Scalar @json['dose'] if @json['dose']
+  dose: ->
+    # In Bonnie, dose can be specified in two different contexts: CMD specification and as a field value; the
+    # CMD version used 'unit' and 'value', while the field value version uses 'units' and 'scalar'; we want to
+    # consolidate the versions, so here we convert everything to the field value style
+    if @json.dose
+      units: @json.dose.units || @json.dose.unit
+      scalar: @json.dose.scalar || @json.dose.value
 
   ###*
   @returns {CodedValue}
   ###
   site: -> hQuery.createCodedValue @json['site'] if @json['site']
 
+  ###*
+  @returns {CodedValue}
+  ###
+  anatomicalApproach: ->
+    #backwards compatibility for older patient records
+    if @json['anatomicalApproach'] then hQuery.createCodedValue @json['anatomicalApproach'] else @site()
   ###*
   @returns {hQuery.DoseRestriction}
   ###
@@ -237,6 +277,11 @@ class hQuery.Medication  extends hQuery.CodedEntry
   ###
   deliveryMethod: -> hQuery.createCodedValue @json['deliveryMethod']
 
+  ###*
+  @returns {CodedValue}
+  ###
+  method: -> hQuery.createCodedValue @json['method']
+
   ###*
   @returns {hQuery.MedicationInformation}
   ###
@@ -258,20 +303,21 @@ class hQuery.Medication  extends hQuery.CodedEntry
   @returns {String} free text instructions to the patient
   ###
   patientInstructions: -> @json['patientInstructions']
-  
+
   ###*
   The duration over which this medication has been active. For example, 5 days.
   @returns {Hash} with two keys: unit and scalar
   ###
   cumulativeMedicationDuration: -> @json['cumulativeMedicationDuration']
 
+  refills: -> @json['refills']
   ###*
   @returns {Array} an array of {@link FulFillment} objects
   ###
   fulfillmentHistory: ->
     for order in @json['fulfillmentHistory']
       new hQuery.Fulfillment order
-      
+
   ###*
   @returns {Array} an array of {@link OrderInformation} objects
   ###