hquery-patient-api 1.0.4 → 1.1.0

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

@@ -3,6 +3,8 @@
 # =require condition.js.coffee
 # =require encounter.js.coffee
 # =require procedure.js.coffee
+# =require communication.js.coffee
+# =require familyhistory.js.coffee
 # =require result.js.coffee
 # =require immunization.js.coffee
 # =require allergy.js.coffee
@@ -13,6 +15,8 @@
 # =require caregoal.js.coffee
 # =require medicalequipment.js.coffee
 # =require functionalstatus.js.coffee
+# =require careexperience.js.coffee
+# =require assessment.js.coffee
 
 ###*
 @namespace scoping into the hquery namespace
@@ -29,28 +33,28 @@ class hQuery.Supports
   @returns {DateRange}
   ###
   supportDate: -> new hQuery.DateRange @json['supportDate']
-    
+
   ###*
-  @returns {Person} 
+  @returns {Person}
   ###
   guardian: -> new hQuery.Person @json['guardian']
-  
+
   ###*
   @returns {String}
   ###
   guardianSupportType: -> @json['guardianSupportType']
-  
+
   ###*
   @returns {Person}
   ###
   contact: -> new hQuery.Person @json['contact']
-  
+
   ###*
   @returns {String}
   ###
   contactSupportType: -> @json['guardianSupportType']
-  
-  
+
+
 ###*
 @class Representation of a patient
 @augments hQuery.Person
@@ -66,8 +70,8 @@ class hQuery.Patient extends hQuery.Person
   @returns {Date} containing the patients birthdate
   ###
   birthtime: ->
-    hQuery.dateFromUtcSeconds @json['birthdate']
-    
+    hQuery.dateFromUtcSeconds @json['birthdate'] if @json['birthdate']
+
   ###*
   @param (Date) date the date at which the patient age is calculated, defaults to now.
   @returns {number} the patient age in years
@@ -76,7 +80,7 @@ class hQuery.Patient extends hQuery.Person
     oneDay = 24*60*60*1000;
     oneYear = 365*oneDay;
     return (date.getTime()-this.birthtime().getTime())/oneYear;
-    
+
   ###*
   @returns {CodedValue} the domestic partnership status of the patient
   The following HL7 codeset is used:
@@ -90,53 +94,63 @@ class hQuery.Patient extends hQuery.Person
   T  Domestic Partner
   W  Widowed
   ###
-  maritalStatus: -> 
+  maritalStatus: ->
     if @json['maritalStatus']
       return hQuery.createCodedValue @json['maritalStatus']
-  
+
   ###*
   @returns {CodedValue}  of the spiritual faith affiliation of the patient
   It uses the HL7 codeset.  http://www.hl7.org/memonly/downloads/v3edition.cfm#V32008
   ###
-  religiousAffiliation: -> 
+  religiousAffiliation: ->
     if @json['religiousAffiliation']
       return hQuery.createCodedValue @json['religiousAffiliation']
-  
+
   ###*
   @returns {CodedValue}  of the race of the patient
   CDC codes:  http://phinvads.cdc.gov/vads/ViewCodeSystemConcept.action?oid=2.16.840.1.113883.6.238&code=1000-9
   ###
-  race: -> 
+  race: ->
     if @json['race']
-      return hQuery.createCodedValue @json['race']
-  
+      return hQuery.createCodedValue code: @json['race'], code_system: 'CDC Race'
+
+  ###*
+  @returns {CodedValue} of the payer of the patient
+  SOP codes: https://www.health.ny.gov/statistics/sparcs/sysdoc/appp.htm
+  ###
+  payer: ->
+    if @json['insurance_providers']?.length
+      ip = @json['insurance_providers'][0]
+      if ip.codes && ip.codes.SOP?.length
+        return hQuery.createCodedValue code: ip.codes.SOP[0], code_system: 'SOP'
+
   ###*
   @returns {CodedValue} of the ethnicity of the patient
   CDC codes:  http://phinvads.cdc.gov/vads/ViewCodeSystemConcept.action?oid=2.16.840.1.113883.6.238&code=1000-9
   ###
-  ethnicity: -> 
+  ethnicity: ->
     if @json['ethnicity']
-      return hQuery.createCodedValue @json['ethnicity']
-  
+      return hQuery.createCodedValue code: @json['ethnicity'], code_system: 'CDC Ethnicity'
+
   ###*
   @returns {CodedValue} This is the code specifying the level of confidentiality of the document.
   HL7 Confidentiality Code (2.16.840.1.113883.5.25)
   ###
-  confidentiality: -> 
+  confidentiality: ->
     if  @json['confidentiality']
       return hQuery.createCodedValue @json['confidentiality']
-  
+
   ###*
   @returns {Address} of the location where the patient was born
   ###
-  birthPlace: -> 
+  birthPlace: ->
     new hQuery.Address @json['birthPlace']
-  
+
   ###*
   @returns {Supports} information regarding key support contacts relative to healthcare decisions, including next of kin
   ###
   supports: -> new hQuery.Supports @json['supports']
-  
+
   ###*
   @returns {Organization}
   ###
@@ -146,8 +160,8 @@ class hQuery.Patient extends hQuery.Person
   @returns {Provider}  the providers associated with the patient
   ###
   provider: -> new hQuery.Provider @json['provider']
-  
-   
+
+
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link hQuery.LanguagesSpoken} objects
   Code from http://www.ietf.org/rfc/rfc4646.txt representing the name of the human language
@@ -164,11 +178,6 @@ class hQuery.Patient extends hQuery.Person
   ###
   expired: -> @json['expired']
 
-  ###*
-  @returns {Boolean} returns true if the patient participated in a clinical trial
-  ###
-  clinicalTrialParticipant: -> @json['clinicalTrialParticipant']
-
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link hQuery.Encounter} objects
   ###
@@ -178,7 +187,7 @@ class hQuery.Patient extends hQuery.Person
       for encounter in @json['encounters']
         list.pushIfUsable(new hQuery.Encounter(encounter))
     list
-    
+
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link Medication} objects
   ###
@@ -188,7 +197,7 @@ class hQuery.Patient extends hQuery.Person
       for medication in @json['medications']
         list.pushIfUsable(new hQuery.Medication(medication))
     list
-      
+
 
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link Condition} objects
@@ -209,7 +218,47 @@ class hQuery.Patient extends hQuery.Person
       for procedure in @json['procedures']
         list.pushIfUsable(new hQuery.Procedure(procedure))
     list
-      
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Communication} objects
+  ###
+  communications: ->
+    list = new hQuery.CodedEntryList
+    if @json['communications']
+      for communication in @json['communications']
+        list.pushIfUsable(new hQuery.Communication(communication))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link FamilyHistory} objects
+  ###
+  family_history: ->
+    list = new hQuery.CodedEntryList
+    if @json['family_history']
+      for familyhistory in @json['family_history']
+        list.pushIfUsable(new hQuery.FamilyHistory(familyhistory))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link CareExperience} objects
+  ###
+  careExperiences: ->
+    list = new hQuery.CodedEntryList
+    if @json['care_experiences']
+      for care_experience in @json['care_experiences']
+        list.pushIfUsable(new hQuery.CareExperience(care_experience))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Assessment} objects
+  ###
+  assessments: ->
+    list = new hQuery.CodedEntryList
+    if @json['assessments']
+      for assessment in @json['assessments']
+        list.pushIfUsable(new hQuery.Assessment(assessment))
+    list
+
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link Result} objects
   ###
@@ -239,8 +288,8 @@ class hQuery.Patient extends hQuery.Person
       for immunization in @json['immunizations']
         list.pushIfUsable(new hQuery.Immunization(immunization))
     list
-    
-    
+
+
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link Allergy} objects
   ###
@@ -260,7 +309,7 @@ class hQuery.Patient extends hQuery.Person
       for pregnancy in @json['pregnancies']
         list.pushIfUsable(new hQuery.Pregnancy(pregnancy))
     list
-    
+
   ###*
   @returns {hQuery.CodedEntryList} A list of {@link Socialhistory} objects
   ###

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

@@ -10,15 +10,14 @@ This includes information about the patients current and past pregnancy status
 The Coded Entry code system should be SNOMED-CT
 @class
 @augments hQuery.CodedEntry
-@exports Pregnancy as hQuery.Pregnancy 
+@exports Pregnancy as hQuery.Pregnancy
 ###
 class hQuery.Pregnancy extends hQuery.CodedEntry
   constructor: (@json) ->
     super(@json)
-  
+
 
   ###*
   @returns {String}
   ###
   comment: -> @json['comment']
-  

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

@@ -6,23 +6,28 @@ this.hQuery ||= {}
 
 # =require core.coffee
 ###*
-This represents all interventional, surgical, diagnostic, or therapeutic procedures or 
+This represents all interventional, surgical, diagnostic, or therapeutic procedures or
 treatments pertinent to the patient.
 @class
 @augments hQuery.CodedEntry
-@exports Procedure as hQuery.Procedure 
+@exports Procedure as hQuery.Procedure
 ###
 class hQuery.Procedure extends hQuery.CodedEntry
   constructor: (@json) ->
     super(@json)
-  
+    @_facility = new hQuery.Facility @json['facility'] if @json['facility']
+
+
+  facility: -> @_facility
+  facilityArrival: -> @_facility?.startDate()
+  facilityDeparture: -> @_facility?.endDate()
   ###*
   @returns {hQuery.Actor} The provider that performed the procedure
   ###
   performer: -> new hQuery.Actor @json['performer'] if @json['performer']
-  
+
   ###*
-  @returns {hQuery.CodedValue} A SNOMED code indicating the body site on which the 
+  @returns {hQuery.CodedValue} A SNOMED code indicating the body site on which the
   procedure was performed
   ###
   site: -> new hQuery.CodedValue @json['site']?['code'], @json['site']?['code_system']
@@ -30,7 +35,7 @@ class hQuery.Procedure extends hQuery.CodedEntry
   ###*
   @returns {hQuery.CodedValue} A SNOMED code indicating where the procedure was performed.
   ###
-  source: -> 
+  source: ->
     hQuery.createCodedValue @json['source']
 
   ###*
@@ -43,3 +48,46 @@ class hQuery.Procedure extends hQuery.CodedEntry
   @returns {CodedValue}
   ###
   ordinality: -> hQuery.createCodedValue @json['ordinality']
+
+  ###*
+  @returns {hQuery.CodedValue} A code indicating the approach body site on which the
+  procedure was performed
+  ###
+  anatomicalApproach: -> new hQuery.CodedValue @json['anatomicalApproach']?['code'], @json['anatomicalApproach']?['code_system']
+
+  ###*
+  @returns {hQuery.CodedValue} A  code indicating the body site on which the
+  procedure was performed
+  ###
+  anatomicalLocation: ->
+    #backwards compatibility with older patient records.  site was used for anatomicalLocation
+    at = @json['anatomicalLocation']
+    if at? then new hQuery.CodedValue(at['code'], at['code_system']) else @site()
+
+  ###*
+  @returns {CodedValue}
+  ###
+  method: ->  new hQuery.createCodedValue @json['method']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: ->  new hQuery.createCodedValue @json['reaction']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  radiationDose: ->  new hQuery.createCodedValue @json['radiationDose']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  radiationDuration: ->  new hQuery.createCodedValue @json['radiationDuration']
+
+  ###*
+  The resulting status of a procedure as defined in the QDM documentation. This is different
+  than the status_code associated with the `CodedEntry` object, which relates to the data criteria
+  status as defined in health-data-standards/lib/hqmf-model/data_criteria.json.
+  @returns {CodedValue}
+  ###
+  qdmStatus: ->  new hQuery.createCodedValue @json['qdm_status']

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

@@ -6,7 +6,7 @@ this.hQuery ||= {}
 
 # =require core.coffee
 ###*
-@class 
+@class
 
 @exports Provider as hQuery.Provider
 ###
@@ -17,39 +17,35 @@ class hQuery.Provider
   @returns {hQuery.Person}
   ###
   providerEntity: -> new hQuery.Person @json['providerEntity'] if @json['providerEntity']
-  
+
   ###*
   @returns {hQuery.DateRange}
   ###
   careProvisionDateRange: -> new hQuery.DateRange @json['careProvisionDateRange'] if @json['careProvisionDateRange']
-      
+
   ###*
   @returns {hQuery.CodedValue}
   ###
   role: -> hQuery.createCodedValue @json['role']
-  
+
   ###*
   @returns {String}
   ###
   patientID: -> @json['patientID']
-  
-  
+
+
   ###*
   @returns {hQuery.CodedValue}
   ###
   providerType: -> hQuery.createCodedValue @json['providerType']
-    
-  
+
+
   ###*
   @returns {String}
   ###
   providerID: -> @json['providerID']
-    
+
   ###*
   @returns {hQuery.Organization}
   ###
   organizationName: -> new hQuery.Organization @json
-    
-    
-    
-    

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

@@ -12,7 +12,7 @@ ultrasound, CT, MRI, angiography, cardiac echo, nuclear medicine, pathology, and
 observations.
 @class
 @augments hQuery.CodedEntry
-@exports Result as hQuery.Result 
+@exports Result as hQuery.Result
 ###
 class hQuery.Result extends hQuery.CodedEntry
   constructor: (@json) ->
@@ -30,14 +30,31 @@ class hQuery.Result extends hQuery.CodedEntry
   @returns {CodedValue}
   ###
   interpretation: -> hQuery.createCodedValue  @json['interpretation']
-  
+
   ###*
   @returns {String}
   ###
   referenceRange: -> @json['referenceRange']
-  
+
+  ###*
+  @returns {String}
+  ###
+  referenceRangeHigh: -> @json['referenceRangeHigh']
+
+  ###*
+  @returns {String}
+  ###
+  referenceRangeLow: -> @json['referenceRangeLow']
+
   ###*
   @returns {String}
   ###
   comment: -> @json['comment']
-  
+
+  ###*
+  The resulting status of a procedure as defined in the QDM documentation. This is different
+  than the status_code associated with the `CodedEntry` object, which relates to the data criteria
+  status as defined in health-data-standards/lib/hqmf-model/data_criteria.json.
+  @returns {CodedValue}
+  ###
+  qdmStatus: -> hQuery.createCodedValue  @json['qdm_status']