hquery-patient-api 0.3.0

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

@@ -0,0 +1,56 @@
+###*
+@namespace scoping into the hquery namespace
+###
+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,
+or treating the patient's condition. It may include visits, appointments, as well
+as non face-to-face interactions. It is also a contact between a patient and a
+practitioner who has primary responsibility for assessing and treating the
+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 
+###
+class hQuery.Encounter extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+  	
+  ###*
+  @returns {String}
+  ####
+  dischargeDisp: -> @json['dischargeDisp']
+  
+  ###*
+  A code indicating the priority of the admission (e.g., Emergency, Urgent, Elective, et cetera) from
+  National Uniform Billing Committee (NUBC)
+  @returns {CodedValue}
+  ###
+  admitType: -> new hQuery.CodedValue @json['admitType']['code'], @json['admitType']['codeSystem']
+  
+  ###*
+  @returns {hQuery.Actor}
+  ###
+  performer: -> new hQuery.Actor @json['performer']
+  
+  ###*
+  @returns {hQuery.Organization}
+  ###
+  facility: -> new hQuery.Facility @json['facility']
+
+  ###*
+  @returns {hQuery.DateRange}
+  ###
+  encounterDuration: -> new hQuery.DateRange @json
+  
+  ###*
+  @returns {hQuery.CodedEntry}
+  ###
+  reasonForVisit: -> new hQuery.CodedEntry @json['reason']
+  

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

@@ -0,0 +1,48 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+###*
+This class can be used to represnt 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.
+
+In the previously mentioned specifications, functional status may represented
+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
+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"
+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 
+###
+class hQuery.FunctionalStatus extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+
+  ###*
+  Either "condition" or "result"
+  @returns {String}
+  ###
+  type: -> @json["type"]
+
+  ###*
+  A coded value. Like a code for patient supplied.
+  @returns {hQuery.CodedValue}
+  ###
+  source: ->
+    if @json["source"]?
+      new hQuery.CodedValue @json["source"]["code"], @json["source"]["codeSystem"]
+  

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

@@ -0,0 +1,115 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+# =require medication.coffee
+
+###*
+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
+It indicates the reason an immunization was not administered.
+
+@class NoImmunization - describes the status of the medication
+@augments hQuery.CodedEntry
+@exports NoImmunization as hQuery.NoImmunization
+###
+class hQuery.NoImmunization extends hQuery.CodedValue
+  IMMUNITY = "IMMUNE"
+  MED_PRECAUTION = "MEDPREC"
+  OUT_OF_STOCK = "OSTOCK"
+  PAT_OBJ = "PATOBJ"
+  PHIL_OBJ = "PHILISOP"
+  REL_OBJ = "RELIG"  
+  VAC_EFF = "VACEFF"
+  VAC_SAFETY = "VACSAF"
+
+  ###*
+  @returns {Boolean}
+  ###
+  isImmune: -> @c is IMMUNITY
+
+  ###*
+  @returns {Boolean}
+  ###
+  isMedPrec: -> @c is MED_PRECAUTION
+
+  ###*
+  @returns {Boolean}
+  ###
+  isOstock: -> @c is OUT_OF_STOCK
+
+  ###*
+  @returns {Boolean}
+  ###
+  isPatObj: -> @c is PAT_OBJ
+	
+  ###*
+  @returns {Boolean}
+  ###
+  isPhilisop: -> @c is PHIL_OBJ	
+  
+  ###*
+  @returns {Boolean}
+  ###
+  isRelig: -> @c is REL_OBJ
+  
+  ###*
+  @returns {Boolean}
+  ###
+  isVacEff: -> @c is VAC_EFF
+  
+  ###*
+  @returns {Boolean}
+  ###
+  isVacSaf: -> @c is VAC_SAFETY
+
+
+###*
+@class represents a immunization entry for a patient.
+@augments hQuery.CodedEntry
+@exports Immunization as hQuery.Immunization
+###
+class hQuery.Immunization extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+   
+  ###*
+  @returns{hQuery.Scalar} 
+  ###
+  medicationSeriesNumber: ->  new hQuery.Scalar @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']
+  
+  ###*
+  @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
+  It indicates the reason an immunization was not administered.
+  @returns {hQuery.NoImmunization}   Used to indicate reason an immunization was not administered.
+  ###
+  refusalReason: -> new hQuery.NoImmunization @json['negationReason']['code'], @json['negationReason']['codeSystem']
+ 

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

@@ -0,0 +1,29 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+@class 
+@augments hQuery.CodedEntry
+@exports Language as hQuery.Language
+###
+class hQuery.Language extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+  
+  ###*
+  @returns {hQuery.CodedValue}
+  ###
+  modeCode: -> new hQuery.CodedValue @json['modeCode']['code'], @json['modeCode']['codeSystem']
+  
+  ###*
+  @returns {String}
+  ###
+  preferenceIndicator: -> @json['preferenceIndicator']
+
+    
+    
+    

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

@@ -0,0 +1,28 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+
+###*
+
+The Medical Equipment section contains information describing a patients implanted and external medical devices and equipment that their health status depends on, as well as any pertinent equipment or device history.
+
+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 
+@augments hQuery.CodedEntry
+###  
+class hQuery.MedicalEquipment extends hQuery.CodedEntry
+  
+  constructor: (@json) ->
+    super(@json)
+
+  ###*
+  @returns {CodedValue}
+  ###
+  anatomicalStructure: -> new hQuery.CodedValue @json['anatomicalStructure']['code'], @json['anatomicalStructure']['codeSystem']

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

@@ -0,0 +1,280 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+
+# =require core.coffee
+###*
+@class MedicationInformation
+@exports MedicationInformation as hQuery.MedicationInformation
+###
+class hQuery.MedicationInformation
+  constructor: (@json) ->
+
+  ###*
+  An array of hQuery.CodedValue describing the medication
+  @returns {Array}
+  ####
+  codedProduct: -> hQuery.createCodedValues @json['codes']
+  freeTextProductName: -> @json['description']
+  codedBrandName: -> @json['codedBrandName']
+  freeTextBrandName: -> @json['brandName']
+  drugManufacturer: ->
+    if(@json['drugManufacturer'])
+      new hQuery.Organization(@json['drugManufacturer'])
+
+###*
+@class AdministrationTiming - the
+@exports AdministrationTiming as hQuery.AdministrationTiming
+###
+class hQuery.AdministrationTiming
+  constructor: (@json) ->
+
+  ###*
+  Provides the period of medication administration as a Scalar. An example
+  Scalar that would be returned would be with value = 8 and units = hours. This would
+  mean that the medication should be taken every 8 hours.
+  @returns {hQuery.Scalar}
+  ###
+  period: -> new hQuery.Scalar @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). 
+  If true, then the frequency of administration is important (e.g., 3 times per day).
+  @returns {Boolean}
+  ###
+  institutionSpecified: -> @json['institutionSpecified']
+
+###*
+@class DoseRestriction -  restrictions on the medications dose, represented by a upper and lower dose
+@exports DoseRestriction as hQuery.DoseRestriction
+###
+class hQuery.DoseRestriction
+  constructor: (@json) ->
+  numerator: -> new hQuery.Scalar @json['numerator']
+  denominator: -> new hQuery.Scalar @json['denominator']
+
+
+###*
+@class Fulfillment - information about when and who fulfilled an order for the medication
+@exports Fulfillment as hQuery.Fullfilement
+###
+class hQuery.Fulfillment
+  constructor: (@json) ->
+
+  dispenseDate: -> hQuery.dateFromUtcSeconds @json['dispenseDate']
+  dispensingPharmacyLocation: -> new hQuery.Address @json['dispensingPharmacyLocation']
+  quantityDispensed: -> new hQuery.Scalar @json['quantityDispensed']
+  prescriptionNumber: -> @json['prescriptionNumber']
+  fillNumber: -> @json['fillNumber']
+  fillStatus: -> new hQuery.Status @json['fillStatus']
+
+###*
+@class OrderInformation - information abour an order for a medication
+@exports OrderInformation as hQuery.OrderInformation
+###
+class hQuery.OrderInformation
+  constructor: (@json) ->
+  
+  orderNumber: -> @json['orderNumber']
+  fills: -> @json['fills']
+  quantityOrdered: -> new hQuery.Scalar @json['quantityOrdered']
+  orderExpirationDateTime: -> hQuery.dateFromUtcSeconds @json['orderExpirationDateTime']
+  orderDateTime: -> hQuery.dateFromUtcSeconds @json['orderDateTime']
+
+
+###*
+TypeOfMedication as defined by value set 2.16.840.1.113883.3.88.12.3221.8.19
+which pulls two values from SNOMED to describe whether a medication is
+prescription or over the counter
+
+@class TypeOfMedication - describes whether a medication is prescription or
+       over the counter
+@augments hQuery.CodedEntry
+@exports TypeOfMedication as hQuery.TypeOfMedication
+###
+class hQuery.TypeOfMedication extends hQuery.CodedValue
+  PRESECRIPTION = "73639000" # SNOMED code for preseciption medications
+  OTC = "329505003" # SNOMED code for over the counter medications
+
+  ###*
+  @returns {Boolean}
+  ###
+  isPrescription: -> @c is PRESECRIPTION
+
+  ###*
+  @returns {Boolean}
+  ###
+  isOverTheCounter: -> @c is OTC
+
+
+###*
+StatusOfMedication as defined by value set 2.16.840.1.113883.1.11.20.7
+The terms come from SNOMED and are managed by HL7
+
+@class StatusOfMedication - describes the status of the medication
+@augments hQuery.CodedEntry
+@exports StatusOfMedication as hQuery.StatusOfMedication
+###
+class hQuery.StatusOfMedication extends hQuery.CodedValue
+  ON_HOLD = "392521001"
+  NO_LONGER_ACTIVE = "421139008"
+  ACTIVE = "55561003"
+  PRIOR_HISTORY = "73425007"
+
+  ###*
+  @returns {Boolean}
+  ###
+  isOnHold: -> @c is ON_HOLD
+
+  ###*
+  @returns {Boolean}
+  ###
+  isNoLongerActive: -> @c is NO_LONGER_ACTIVE
+
+  ###*
+  @returns {Boolean}
+  ###
+  isActive: -> @c is ACTIVE
+
+  ###*
+  @returns {Boolean}
+  ###
+  isPriorHistory: -> @c is PRIOR_HISTORY
+
+###*
+@class represents a medication entry for a patient.
+@augments hQuery.CodedEntry
+@exports Medication as hQuery.Medication
+###
+class hQuery.Medication  extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+  
+  ###*
+  @returns {String}
+  ####
+  freeTextSig: -> @json['freeTextSig']
+
+  ###*
+  The actual or intended start of a medication. Slight deviation from greenCDA for C32 since
+  it combines this with medication stop
+  @returns {Date}
+  ###
+  indicateMedicationStart: -> hQuery.dateFromUtcSeconds @json['start_time']
+
+  ###*
+  The actual or intended stop of a medication. Slight deviation from greenCDA for C32 since
+  it combines this with medication start
+  @returns {Date}
+  ###
+  indicateMedicationStop: -> hQuery.dateFromUtcSeconds @json['end_time']
+
+  administrationTiming: -> new hQuery.AdministrationTiming @json['administrationTiming']
+
+  ###*
+  @returns {CodedValue}  Contains routeCode or adminstrationUnitCode information.
+    Route code shall have a a value drawn from FDA route of adminstration,
+    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
+    dosage form, source NCI thesaurus and represents the physical form of the
+    product as presented to the patient.
+    See http://www.fda.gov/Drugs/InformationOnDrugs/ucm142454.htm
+  ###
+  route: -> new hQuery.CodedValue @json['route']['code'], @json['route']['codeSystem']
+
+  ###*
+  @returns {hQuery.Scalar} the dose
+  ###
+  dose: -> new hQuery.Scalar @json['dose']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  site: -> new hQuery.CodedValue @json['site']['code'], @json['site']['codeSystem']
+
+  ###*
+  @returns {hQuery.DoseRestriction}
+  ###
+  doseRestriction: -> new hQuery.DoseRestriction @json['doseRestriction']
+
+  ###*
+  @returns {String}
+  ###
+  doseIndicator: -> @json['doseIndicator']
+
+  ###*
+  @returns {String}
+  ###
+  fulfillmentInstructions: -> @json['fulfillmentInstructions']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  indication: -> new hQuery.CodedValue @json['indication']['code'], @json['indication']['codeSystem']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  productForm: -> new hQuery.CodedValue @json['productForm']['code'], @json['productForm']['codeSystem']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  vehicle: -> new hQuery.CodedValue @json['vehicle']['code'], @json['vehicle']['codeSystem']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  reaction: -> new hQuery.CodedValue @json['reaction']['code'], @json['reaction']['codeSystem']
+
+  ###*
+  @returns {CodedValue}
+  ###
+  deliveryMethod: -> new hQuery.CodedValue @json['deliveryMethod']['code'], @json['deliveryMethod']['codeSystem']
+
+  ###*
+  @returns {hQuery.MedicationInformation}
+  ###
+  medicationInformation: -> new hQuery.MedicationInformation @json
+
+  ###*
+  @returns {hQuery.TypeOfMedication} Indicates whether this is an over the counter or prescription medication
+  ###
+  typeOfMedication: -> new hQuery.TypeOfMedication @json['typeOfMedication']['code'], @json['typeOfMedication']['codeSystem']
+
+  ###*
+  Values conform to value set 2.16.840.1.113883.1.11.20.7 - Medication Status
+  Values may be: On Hold, No Longer Active, Active, Prior History
+  @returns {hQuery.StatusOfMedication}   Used to indicate the status of the medication.
+  ###
+  statusOfMedication: -> new hQuery.StatusOfMedication @json['statusOfMedication']['code'], @json['statusOfMedication']['codeSystem']
+
+  ###*
+  @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']
+
+  ###*
+  @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
+  ###
+  orderInformation: ->
+    for order in @json['orderInformation']
+      new hQuery.OrderInformation order