hquery-patient-api 0.3.0

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

@@ -0,0 +1,302 @@
+# =require core.js.coffee
+# =require medication.js.coffee
+# =require condition.js.coffee
+# =require encounter.js.coffee
+# =require procedure.js.coffee
+# =require result.js.coffee
+# =require immunization.js.coffee
+# =require allergy.js.coffee
+# =require provider.js.coffee
+# =require languages.js.coffee
+# =require pregnancy.js.coffee
+# =require socialhistory.js.coffee
+# =require caregoal.js.coffee
+# =require medicalequipment.js.coffee
+# =require functionalstatus.js.coffee
+
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+###*
+@class Supports
+@exports Supports as hQuery.Supports
+###
+class hQuery.Supports
+  constructor: (@json) ->
+  ###*
+  @returns {DateRange}
+  ###
+  supportDate: -> new hQuery.DateRange @json['supportDate']
+    
+  ###*
+  @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
+@exports Patient as hQuery.Patient
+###
+class hQuery.Patient extends hQuery.Person
+  ###*
+  @returns {String} containing M or F representing the gender of the patient
+  ###
+  gender: -> @json['gender']
+
+  ###*
+  @returns {Date} containing the patient's birthdate
+  ###
+  birthtime: ->
+    hQuery.dateFromUtcSeconds @json['birthdate']
+    
+  ###*
+  @param (Date) date the date at which the patient age is calculated, defaults to now.
+  @returns {number} the patient age in years
+  ###
+  age: (date = new Date()) ->
+    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:
+  A  Annulled
+  D  Divorced
+  I   Interlocutory
+  L  Legally separated
+  M  Married
+  P  Polygamous
+  S  Never Married
+  T  Domestic Partner
+  W  Widowed
+  ###
+  maritalStatus: -> 
+    if @json['maritalStatus']
+      return new hQuery.CodedValue @json['maritalStatus']['code'], @json['maritalStatus']['codeSystem']
+  
+  ###*
+  @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: -> 
+    if @json['religiousAffiliation']
+      return new hQuery.CodedValue @json['religiousAffiliation']['code'], @json['religiousAffiliation']['codeSystem']
+  
+  ###*
+  @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: -> 
+    if @json['race']
+      return new hQuery.CodedValue @json['race']['code'], @json['race']['codeSystem']
+  
+  ###*
+  @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: -> 
+    if @json['ethnicity']
+      return new hQuery.CodedValue @json['ethnicity']['code'], @json['ethnicity']['codeSystem']
+  
+  ###*
+  @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: -> 
+    if  @json['confidentiality']
+      return new hQuery.CodedValue @json['confidentiality']['code'], @json['confidentiality']['codeSystem']
+  
+  ###*
+  @returns {Address} of the location where the patient was born
+  ###
+  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}
+  ###
+  custodian: -> new hQuery.Organization @json['custodian']
+
+  ###*
+  @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
+  ###
+  languages: ->
+    list = new hQuery.CodedEntryList
+    if @json['languages']
+      for language in @json['languages']
+        list.push(new hQuery.Language(language))
+    list
+
+  ###*
+  @returns {Boolean} returns true if the patient has died
+  ###
+  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
+  ###
+  encounters: ->
+    list = new hQuery.CodedEntryList
+    if @json['encounters']
+      for encounter in @json['encounters']
+        list.pushIfUsable(new hQuery.Encounter(encounter))
+    list
+    
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Medication} objects
+  ###
+  medications: ->
+    list = new hQuery.CodedEntryList
+    if @json['medications']
+      for medication in @json['medications']
+        list.pushIfUsable(new hQuery.Medication(medication))
+    list
+      
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Condition} objects
+  ###
+  conditions: ->
+    list = new hQuery.CodedEntryList
+    if @json['conditions']
+      for condition in @json['conditions']
+        list.pushIfUsable(new hQuery.Condition(condition))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Procedure} objects
+  ###
+  procedures: ->
+    list = new hQuery.CodedEntryList
+    if @json['procedures']
+      for procedure in @json['procedures']
+        list.pushIfUsable(new hQuery.Procedure(procedure))
+    list
+      
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Result} objects
+  ###
+  results: ->
+    list = new hQuery.CodedEntryList
+    if @json['results']
+      for result in @json['results']
+        list.pushIfUsable(new hQuery.Result(result))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Result} objects
+  ###
+  vitalSigns: ->
+    list = new hQuery.CodedEntryList
+    if @json['vital_signs']
+      for vital in @json['vital_signs']
+        list.pushIfUsable(new hQuery.Result(vital))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Immunization} objects
+  ###
+  immunizations: ->
+    list = new hQuery.CodedEntryList
+    if @json['immunizations']
+      for immunization in @json['immunizations']
+        list.pushIfUsable(new hQuery.Immunization(immunization))
+    list
+    
+    
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Allergy} objects
+  ###
+  allergies: ->
+    list = new hQuery.CodedEntryList
+    if @json['allergies']
+      for allergy in @json['allergies']
+        list.pushIfUsable(new hQuery.Allergy(allergy))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Pregnancy} objects
+  ###
+  pregnancies: ->
+    list = new hQuery.CodedEntryList
+    if @json['pregnancies']
+      for pregnancy in @json['pregnancies']
+        list.pushIfUsable(new hQuery.Pregnancy(pregnancy))
+    list
+    
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link Socialhistory} objects
+  ###
+  socialHistories: ->
+    list = new hQuery.CodedEntryList
+    if @json['socialhistories']
+      for socialhistory in @json['socialhistories']
+        list.pushIfUsable(new hQuery.Socialhistory(socialhistory))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link CareGoal} objects
+  ###
+  careGoals: ->
+    list = new hQuery.CodedEntryList
+    if @json['care_goals']
+      for caregoal in @json['care_goals']
+        list.pushIfUsable(new hQuery.CareGoal(caregoal))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link MedicalEquipment} objects
+  ###
+  medicalEquipment: ->
+    list = new hQuery.CodedEntryList
+    if @json['medical_equipment']
+      for equipment in @json['medical_equipment']
+        list.pushIfUsable(new hQuery.MedicalEquipment(equipment))
+    list
+
+  ###*
+  @returns {hQuery.CodedEntryList} A list of {@link FunctionalStatus} objects
+  ###
+  functionalStatuses: ->
+    list = new hQuery.CodedEntryList
+    if @json['functional_statuses']
+      for fs in @json['functional_statuses']
+        list.pushIfUsable(new hQuery.FunctionalStatus(fs))
+    list

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

@@ -0,0 +1,24 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+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 
+###
+class hQuery.Pregnancy extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+  
+
+  ###*
+  @returns {String}
+  ###
+  comment: -> @json['comment']
+  

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

@@ -0,0 +1,28 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+This represents all interventional, surgical, diagnostic, or therapeutic procedures or 
+treatments pertinent to the patient.
+@class
+@augments hQuery.CodedEntry
+@exports Procedure as hQuery.Procedure 
+###
+class hQuery.Procedure extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+  
+  ###*
+  @returns {hQuery.Actor} The provider that performed the procedure
+  ###
+  performer: -> new hQuery.Actor @json['performer']
+  
+  ###*
+  @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']['codeSystem']

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

@@ -0,0 +1,55 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+@class 
+
+@exports Provider as hQuery.Provider
+###
+class hQuery.Provider
+  constructor: (@json) ->
+
+  ###*
+  @returns {hQuery.Person}
+  ###
+  providerEntity: -> new hQuery.Person @json['providerEntity']
+  
+  ###*
+  @returns {hQuery.DateRange}
+  ###
+  careProvisionDateRange: -> new hQuery.DateRange @json['careProvisionDateRange']
+      
+  ###*
+  @returns {hQuery.CodedValue}
+  ###
+  role: -> new hQuery.CodedValue @json['role']['code'], @json['role']['codeSystem']
+  
+  ###*
+  @returns {String}
+  ###
+  patientID: -> @json['patientID']
+  
+  
+  ###*
+  @returns {hQuery.CodedValue}
+  ###
+  providerType: -> new hQuery.CodedValue @json['providerType']['code'], @json['providerType']['codeSystem']
+    
+  
+  ###*
+  @returns {String}
+  ###
+  providerID: -> @json['providerID']
+    
+  ###*
+  @returns {hQuery.Organization}
+  ###
+  organizationName: -> new hQuery.Organization @json
+    
+    
+    
+    

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

@@ -0,0 +1,43 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+Observations generated by laboratories, imaging procedures, and other procedures. The scope
+includes hematology, chemistry, serology, virology, toxicology, microbiology, plain x-ray,
+ultrasound, CT, MRI, angiography, cardiac echo, nuclear medicine, pathology, and procedure
+observations.
+@class
+@augments hQuery.CodedEntry
+@exports Result as hQuery.Result 
+###
+class hQuery.Result extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+
+  ###*
+  ASTM CCR defines a restricted set of required result Type codes (see ResultTypeCode in section 7.3
+  Summary of CCD value sets), used to categorize a result into one of several commonly accepted values
+  (e.g. Hematology, Chemistry, Nuclear Medicine).
+  @returns {CodedValue}
+  ###
+  resultType: -> this.type()
+
+  ###*
+  @returns {CodedValue}
+  ###
+  interpretation: -> new hQuery.CodedValue @json['interpretation'].code, @json['interpretation'].codeSystem
+  
+  ###*
+  @returns {String}
+  ###
+  referenceRange: -> @json['referenceRange']
+  
+  ###*
+  @returns {String}
+  ###
+  comment: -> @json['comment']
+