hquery-patient-api 0.3.0

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+tmp/
+.DS_Store
+doc/patient-api
+.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+
+script: bundle exec rake
+
+notifications:
+  email:
+    recipients:
+      - healthcare-ci@googlegroups.com
+    on_failure: change
+
+branches: 
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem 'execjs'
+gem 'sprockets'
+gem 'coffee-script'
+gem 'uglifier'
+gem 'rake'
+gem 'tilt'
+gem 'therubyrhino', :platforms => :jruby
+
+group :test do
+  gem 'minitest'
+  gem 'turn', :require => false
+end

data/LICENSE

@@ -0,0 +1,57 @@
+Copyright 2010 Federal Health Architecture
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   2. You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,34 @@
+hQuery Patient API
+=========
+
+The patient API is a CoffeeScript API for accessing patient information. It defines the model available to queries executing in an [hQuery Gateway](http://github.com/hquery/query-gateway). 
+
+Install Instructions
+--------------------
+
+There is no need to install the patientapi directly, it will be pulled into the [hQuery Gateway](http://github.com/hquery/query-gateway) by Bundler during an install.
+
+See the [hQuery Composer](http://github.com/hquery/query-composer) for installation instructions for both the hQuery Composer and Gateway
+  
+
+License
+-------
+
+Copyright 2011 The MITRE Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+		http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Project Practices
+-----------------
+
+Please try to follow our [Coding Style Guides](http://github.com/eedrummer/styleguide). Additionally, we will be using git in a pattern similar to [Vincent Driessen's workflow](http://nvie.com/posts/a-successful-git-branching-model/). While feature branches are encouraged, they are not required to work on the project.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'sprockets'
+require 'tilt'
+require 'fileutils'
+
+task :default => [:test_units]
+$LOAD_PATH << File.expand_path("../test",__FILE__)
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.pattern = 'test/unit/*_test.rb'
+  t.verbose = true
+  t.warning = false
+}
+
+
+namespace :doc do
+  task :generate_js do
+    ctx = Sprockets::Environment.new(File.expand_path("../", __FILE__))
+    Tilt::CoffeeScriptTemplate.default_bare=true 
+    ctx.append_path "app/assets/javascripts"
+    api = ctx.find_asset('patient')
+    
+    Dir.mkdir('tmp') unless Dir.exists?( 'tmp')
+    
+    File.open('tmp/patient.js', 'w+') do |js_file|
+      js_file.write api
+    end
+  end
+  
+  desc "Generate docs for patient API"
+  task :js => :generate_js do
+    system 'java -jar ./doc/jsdoc-toolkit/jsrun.jar ./doc/jsdoc-toolkit/app/run.js -t=doc/jsdoc-toolkit/templates/jsdoc -a tmp/patient.js -d=doc/patient-api'
+  end
+  
+  task :copydir do
+    Dir.mkdir('patientapi') unless Dir.exists? ('patientapi')
+    cp_r "doc/patient-api", "../query-composer/public/patientapi"
+  end
+    
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,79 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+
+###*
+@class 
+@augments hQuery.CodedEntry
+@exports Allergy as hQuery.Allergy
+###
+class hQuery.Allergy  extends hQuery.CodedEntry
+  constructor: (@json) ->
+    super(@json)
+    
+  ###*
+  Food and substance allergies use the Unique Ingredient Identifier(UNII) from the FDA
+  http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling/ucm162523.htm
+  
+  Allegies to a class of medication Shall contain a value descending from the NDF-RT concept types 
+  of Mechanism of Action - N0000000223, Physiologic Effect - N0000009802 or 
+  Chemical Structure - N0000000002. NUI will be used as the concept code. 
+  For more information, please see the Web Site 
+  http://www.cancer.gov/cancertopics/terminologyresources/page5
+  
+  Allergies to a specific medication shall use RxNorm for the values.  
+  @returns {CodedValue}
+  ###
+  product: -> this.type()
+
+  ###*
+  Date of allergy or adverse event
+  @returns{Date}
+  ###
+  adverseEventDate: -> dateFromUtcSeconds @json['adverseEventDate']
+
+  ###*
+  Adverse event types SHALL be coded as specified in HITSP/C80 Section 2.2.3.4.2 Allergy/Adverse Event Type
+  @returns {CodedValue}
+  ###
+  adverseEventType: -> new hQuery.CodedValue @json['type']['code'], @json['type']['codeSystem']
+
+  ###*
+  This indicates the reaction that may be caused by the product or agent.  
+   It is defined by 2.16.840.1.113883.3.88.12.3221.6.2 and are SNOMED-CT codes.
+  420134006   Propensity to adverse reactions (disorder)
+  418038007   Propensity to adverse reactions to substance (disorder)
+  419511003   Propensity to adverse reactions to drug (disorder)
+  418471000   Propensity to adverse reactions to food (disorder)
+  419199007  Allergy to substance (disorder)
+  416098002  Drug allergy (disorder)
+  414285001  Food allergy (disorder)
+  59037007  Drug intolerance (disorder)
+  235719002  Food intolerance (disorder)
+  @returns {CodedValue} 
+  ###
+  reaction: -> new hQuery.CodedValue @json['reaction']['code'], @json['reaction']['codeSystem']
+
+  ###*
+  This is a description of the level of the severity of the allergy or intolerance.
+  Use SNOMED-CT Codes as defined by 2.16.840.1.113883.3.88.12.3221.6.8
+    255604002  Mild
+    371923003  Mild to Moderate
+    6736007      Moderate
+    371924009  Moderate to Severe
+    24484000    Severe
+    399166001  Fatal
+  @returns {CodedValue} 
+  ###
+  severity: -> new hQuery.CodedValue @json['severity']['code'], @json['severity']['codeSystem']
+
+  ###*
+  Additional comment or textual information
+  @returns {String}
+  ###
+  comment: -> @json['comment']
+
+  

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

@@ -0,0 +1,18 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+
+###*
+
+The plan of care contains data defining prospective or intended orders, interventions, encounters, services, and procedures for the patient.
+
+@exports CareGoal as hQuery.CareGoal 
+@augments hQuery.CodedEntry
+###  
+class hQuery.CareGoal extends hQuery.CodedEntry
+  
+  constructor: (@json) ->
+    super(@json)

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

@@ -0,0 +1,88 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+# =require core.coffee
+
+
+###*
+@class CauseOfDeath
+@exports CauseOfDeath as hQuery.CauseOfDeath
+###
+class hQuery.CauseOfDeath
+  constructor: (@json) ->
+
+  ###*
+  @returns {hQuery.Date}
+  ###
+  timeOfDeath: -> new hQuery.dateFromUtcSeconds @json['timeOfDeath']
+
+  ###*
+  @returns {int}
+  ###
+  ageAtDeath: -> @json['ageAtDeath']
+
+###*
+@class hQuery.Condition
+
+This section is used to describe a patients problems/conditions. The types of conditions
+described have been constrained to the SNOMED CT Problem Type code set. An unbounded
+number of treating providers for the particular condition can be supplied.
+@exports Condition as hQuery.Condition 
+@augments hQuery.CodedEntry
+###  
+class hQuery.Condition extends hQuery.CodedEntry
+  
+  constructor: (@json) ->
+    super(@json)
+  
+  ###*
+   @returns {Array, hQuery.Provider} an array of providers for the condition
+  ###
+  providers: ->
+    for  provider in @json['treatingProviders'] 
+       new Provider provider 
+
+  ###*
+  Diagnosis Priority
+  @returns {int}
+  ###
+  diagnosisPriority: -> @json['priority']
+
+  ###*
+  Ordinality
+  @returns {CodedValue}
+  ###
+  ordinality: -> new hQuery.CodedValue @json['ordinality_code']['code'], @json['ordinality_code']['codeSystem']
+
+  ###*
+  age at onset
+  @returns {int}
+  ###
+  ageAtOnset: -> @json['ageAtOnset']
+  
+  
+  ###*
+  cause of death
+  @returns {hQuery.CauseOfDeath}
+  ###
+  causeOfDeath: -> new hQuery.CauseOfDeath @json['causeOfDeath']
+  
+  ###*
+  problem status
+  @returns {hQuery.CodedValue}
+  ###
+  problemStatus: -> new hQuery.CodedValue @json['problemStatus']['code'], @json['problemStatus']['codeSystem']
+  
+  ###*
+  comment
+  @returns {String}
+  ###
+  comment: -> @json['comment']
+  
+  ###*
+  This is a description of the level of the severity of the condition.
+  @returns {CodedValue} 
+  ###
+  severity: -> new hQuery.CodedValue @json['severity']['code'], @json['severity']['codeSystem']

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

@@ -0,0 +1,556 @@
+###*
+@namespace scoping into the hquery namespace
+###
+this.hQuery ||= {}
+
+###*
+Converts a a number in UTC Seconds since the epoch to a date.
+@param {number} utcSeconds seconds since the epoch in UTC
+@returns {Date}
+@function
+@exports dateFromUtcSeconds as hQuery.dateFromUtcSeconds
+###
+hQuery.dateFromUtcSeconds = (utcSeconds) ->
+  new Date utcSeconds * 1000
+
+###*
+@class Scalar - a representation of a unit and value
+@exports Scalar as hQuery.Scalar
+###
+class hQuery.Scalar
+  constructor: (@json) ->
+  unit: -> @json['unit']
+  value: -> @json['value']
+
+###*
+@class PhysicalQuantity - a representation of a physical quantity
+@exports PhysicalQuantity as hQuery.PhysicalQuantity
+###
+class hQuery.PhysicalQuantity
+  constructor: (@json) ->
+  units: -> @json['units']
+  scalar: -> parseFloat(@json['scalar'])
+
+###*
+@class A code with its corresponding code system
+@exports CodedValue as hQuery.CodedValue
+###
+class hQuery.CodedValue
+  ###*
+  @param {String} c value of the code
+  @param {String} csn name of the code system that the code belongs to
+  @constructs
+  ###
+  constructor: (@c, @csn) ->
+
+  ###*
+  @returns {String} the code
+  ###
+  code: -> @c
+
+  ###*
+  @returns {String} the code system name
+  ###
+  codeSystemName: -> @csn
+  
+  @normalize: (val) ->
+    String(val).toLowerCase()
+
+  ###*
+  Returns true if the contained code and codeSystemName match a code in the supplied codeSet.
+  @param {Object} codeSet a hash with code system names as keys and an array of codes as values
+  @returns {boolean}
+  ###
+  includedIn: (codeSet) ->
+    for codeSystemName, codes of codeSet
+      if @csn==codeSystemName
+        for code in codes
+          c1 = hQuery.CodedValue.normalize(code)
+          c2 = hQuery.CodedValue.normalize(@c)
+          if c1==c2
+            return true
+    return false
+
+###*
+Status as defined by value set 2.16.840.1.113883.5.14,
+the ActStatus vocabulary maintained by HL7
+
+@class Status
+@augments hQuery.CodedEntry
+@exports Status as hQuery.Status
+###
+class hQuery.Status extends hQuery.CodedValue
+  NORMAL = "normal"
+  ABORTED = "aborted"
+  ACTIVE = "active"
+  CANCELLED = "cancelled"
+  COMPLETED = "completed"
+  HELD = "held"
+  NEW = "new"
+  SUSPENDED = "suspended"
+  NULLIFIED = "nullified"
+  OBSOLETE = "obsolete"
+
+  isNormal: -> @c is NORMAL
+  isAborted: -> @c is ABORTED
+  isActive: -> @c is ACTIVE
+  isCancelled: -> @c is CANCELLED
+  isCompleted: -> @c is COMPLETED
+  isHeld: -> @c is HELD
+  isNew: -> @c is NEW
+  isSuspended: -> @c is SUSPENDED
+  isNullified: -> @c is NULLIFIED
+  isObsolete: -> @c is OBSOLETE
+
+
+###*
+@class an Address for a person or organization
+@exports Address as hQuery.Address
+###
+class hQuery.Address
+  constructor: (@json) ->
+  ###*
+  @returns {Array[String]} the street addresses
+  ###
+  street: -> @json['street']
+  ###*
+  @returns {String} the city
+  ###
+  city: -> @json['city']
+  ###*
+  @returns {String} the State
+  ###
+  state: -> @json['state']
+  ###*
+  @returns {String} the postal code
+  ###
+  postalCode: -> @json['zip']
+
+
+###*
+@class An object that describes a means to contact an entity.  This is used to represent
+phone numbers, email addresses,  instant messaging accounts etc.
+@exports Telecom as hQuery.Telecom
+###
+class hQuery.Telecom
+  constructor: (@json) ->
+
+  ###*
+  @returns {String} the type of telecom entry, phone, sms, email ....
+  ###
+  type: -> @json['type']
+
+  ###*
+  @returns {String} the value of the entry -  the actual phone number , email address , ....
+  ###
+  value: -> @json['value']
+
+  ###*
+  @returns {String} the use of the entry. Is it a home, office, .... type of contact
+  ###
+  use: -> @json['use']
+
+  ###*
+  @returns {Boolean} is this a preferred form of contact
+  ###
+  preferred: -> @json['preferred']
+
+
+###*
+@class an object that describes a person.  includes a persons name, addresses, and contact information
+@exports Person as hQuery.Person
+###
+class hQuery.Person
+  constructor: (@json) ->
+  ###*
+   @returns {String} the given name of the person
+  ###
+  given: -> @json['first']
+
+  ###*
+   @returns {String} the last/family name of the person
+  ###
+  last: -> @json['last']
+  
+  ###*
+   @returns {String} the display name of the person
+  ###
+  name: -> 
+    if @json['name']
+      @json['name']
+    else
+      @json['first'] + ' ' + @json['last']
+
+  ###*
+   @returns {Array} an array of {@link hQuery.Address} objects associated with the patient
+  ###
+  addresses: ->
+    list = []
+    if @json['addresses']
+      for address in @json['addresses']
+        list.push(new hQuery.Address(address))
+    list
+    
+  ###*
+  @returns {Array} an array of {@link hQuery.Telecom} objects associated with the person
+  ###
+  telecoms: ->
+    for tel in @json['telecoms']
+      new hQuery.Telecom tel
+
+
+###*
+@class an actor is either a person or an organization
+@exports Actor as hQuery.Actor
+###
+class hQuery.Actor
+  constructor: (@json) ->
+  person: ->
+    if @json['person']
+      new hQuery.Person @json['person']
+  organization: ->
+    if @json['organization']
+      new hQuery.Organization @json['organization']
+
+
+###*
+@class an Organization
+@exports Organization as hQuery.Organization
+###
+class hQuery.Organization
+  constructor: (@json) ->
+  
+  ###*
+  @returns {String} the id for the organization
+  ###
+  organizationId: -> @json['organizationId']
+  
+  ###*
+  @returns {String} the name of the organization
+  ###
+  organizationName: -> @json['name']
+  
+  ###*
+  @returns {Array} an array of {@link hQuery.Address} objects associated with the organization
+  ###
+  addresses: ->
+    list = []
+    if @json['addresses']
+      for address in @json['addresses']
+        list.push(new hQuery.Address(address))
+    list
+    
+  ###*
+  @returns {Array} an array of {@link hQuery.Telecom} objects associated with the organization
+  ###
+  telecoms: ->
+    for tel in @json['telecoms']
+      new hQuery.Telecom tel
+
+###*
+@class a Facility
+@exports Organization as hQuery.Facility
+###
+class hQuery.Facility extends hQuery.CodedValue
+  constructor: (@json) ->
+    if @json['code']?
+      super @json['code']['code'], @json['code']['codeSystem']
+    if @json['start_time']
+      @_startDate = hQuery.dateFromUtcSeconds @json['start_time']
+    if @json['end_time']
+      @_endDate = hQuery.dateFromUtcSeconds @json['end_time']
+
+  ###*
+  @returns {String} the name of the facility
+  ###
+  name: -> @json['name']
+
+  ###*
+  Date and time at which the coded entry started
+  @returns {Date}
+  ###
+  startDate: -> @_startDate
+
+  ###*
+  Date and time at which the coded entry ended
+  @returns {Date}
+  ###
+  endDate: -> @_endDate
+
+
+  ###*
+  @returns {Array} an array of {@link hQuery.Address} objects associated with the facility
+  ###
+  addresses: ->
+    list = []
+    if @json['addresses']
+      for address in @json['addresses']
+        list.push(new hQuery.Address(address))
+    list
+
+  ###*
+  @returns {Array} an array of {@link hQuery.Telecom} objects associated with the facility
+  ###
+  telecoms: ->
+    for tel in @json['telecoms']
+      new hQuery.Telecom tel
+
+
+###*
+@class represents a DateRange in the form of hi and low date values.
+@exports DateRange as hQuery.DateRange
+###
+class hQuery.DateRange
+  constructor: (@json) ->
+  hi: ->
+    if @json['hi']
+      hQuery.dateFromUtcSeconds @json['hi']
+  low: ->
+    hQuery.dateFromUtcSeconds @json['low']
+
+###*
+@class Class used to describe an entity that is providing some form of information.  This does not mean that they are
+providing any treatment just that they are providing information.
+@exports Informant as hQuery.Informant
+###
+class hQuery.Informant
+  constructor: (@json) ->
+  ###*
+  an array of hQuery.Person objects as points of contact
+  @returns {Array}
+  ###
+  contacts: ->
+    for contact in @json['contacts']
+      new hQuery.Person contact
+  ###*
+   @returns {hQuery.Organization} the organization providing the information
+  ###
+  organization: -> new hQuery.Organization @json['organization']
+
+###*
+@class
+@exports CodedEntry as hQuery.CodedEntry
+###
+class hQuery.CodedEntry
+  constructor: (@json) ->
+    if @json['time']
+      @_date = hQuery.dateFromUtcSeconds @json['time']
+    if @json['start_time']
+      @_startDate = hQuery.dateFromUtcSeconds @json['start_time']
+    if @json['end_time']
+      @_endDate = hQuery.dateFromUtcSeconds @json['end_time']
+    @_type = hQuery.createCodedValues @json['codes']
+    @_statusCode = @json['status_code']
+    # id of the entry from the database
+    @id = @json['_id']
+    # id of the entry from the source document if available
+    @source_id = @json['id']
+    @_freeTextType = @json['description']
+
+  ###*
+  Date and time at which the coded entry took place
+  @returns {Date}
+  ###
+  date: -> @_date
+
+  ###*
+  Date and time at which the coded entry started
+  @returns {Date}
+  ###
+  startDate: -> @_startDate
+
+  ###*
+  Date and time at which the coded entry ended
+  @returns {Date}
+  ###
+  endDate: -> @_endDate
+
+  ###*
+  Tries to find a single point in time for this entry. Will first return date if it is present,
+  then fall back to startDate and finally endDate
+  @returns {Date}
+  ###
+  timeStamp: -> @_date || @_startDate || @_endDate
+
+  ###*
+  Determines whether the entry specifies a time range or not
+  @returns {boolean}
+  ###
+  isTimeRange: -> @_startDate? && @_endDate?
+
+  ###*
+  Determines whether a coded entry contains sufficient information (code and at least 
+  one time stamp) to be usable
+  @returns {boolean}
+  ###
+  isUsable: -> @_type.length>0 && (@_date || @_startDate || @_endDate)
+  
+  ###*
+  An Array of CodedValues which describe what kind of coded entry took place
+  @returns {Array}
+  ###
+  type: -> @_type
+
+  ###*
+  A free text description of the type of coded entry
+  @returns {String}
+  ###
+  freeTextType: -> @_freeTextType
+
+  ###*
+  Status for this coded entry
+  @returns {String}
+  ###
+  status: ->
+    if @_statusCode?
+      if @_statusCode['HL7 ActStatus']?
+        return @_statusCode['HL7 ActStatus'][0]
+      else if @_statusCode['SNOMED-CT']?
+        switch @_statusCode['SNOMED-CT'][0]
+          when '55561003'
+            'active'
+          when '73425007'
+            'inactive'
+          when '413322009'
+            'resolved'
+
+  ###*
+  Status for this coded entry
+  @returns {Hash} keys are code systems, values are arrays of codes
+  ###
+  statusCode: -> @_statusCode
+
+  ###*
+  Returns true if any of this entry codes match a code in the supplied codeSet.
+  @param {Object} codeSet a hash with code system names as keys and an array of codes as values
+  @returns {boolean}
+  ###
+  includesCodeFrom: (codeSet) ->
+    for codedValue in @_type
+      if codedValue.includedIn(codeSet)
+        return true
+    return false
+
+  ###*
+  @returns {Boolean} whether the entry was negated
+  ###
+  negationInd: -> @json['negationInd'] || false
+  
+  ###*
+  Returns the values of the result. This will return an array that contains
+  PhysicalQuantity or CodedValue objects depending on the result type.
+  @returns {Array} containing either PhysicalQuantity and/or CodedValues
+  ###
+  values: ->
+    values = []
+    if @json['values']
+      for value in @json['values']
+        if value['scalar']?
+          values.push new hQuery.PhysicalQuantity value
+        else
+          values = values.concat hQuery.createCodedValues value.codes
+    values
+
+
+  ###*
+  Indicates the reason an entry was negated.
+  @returns {hQuery.CodedValue}   Used to indicate reason an immunization was not administered.
+  ###
+  negationReason: -> 
+    if @json['negationReason'] && @json['negationReason']['code'] && @json['negationReason']['codeSystem']
+      new hQuery.CodedValue @json['negationReason']['code'], @json['negationReason']['codeSystem']
+    else
+      null
+
+###*
+@class Represents a list of hQuery.CodedEntry instances. Offers utility methods for matching
+entries based on codes and date ranges
+@exports CodedEntryList as hQuery.CodedEntryList
+###
+class hQuery.CodedEntryList extends Array
+  constructor: ->
+    @push arguments...
+
+  ###*
+  Push the supplied entry onto this list if it is usable
+  @param {CodedEntry} a coded entry that should be added to the list if it is usable
+  ###
+  pushIfUsable: (entry) ->
+    if entry.isUsable()
+      this.push(entry)
+  
+  ###*
+  Return the number of entries that match the
+  supplied code set where those entries occur between the supplied time bounds
+  @param {Object} codeSet a hash with code system names as keys and an array of codes as values
+  @param {Date} start the start of the period during which the entry must occur, a null value will match all times
+  @param {Date} end the end of the period during which the entry must occur, a null value will match all times
+  @param {boolean} includeNegated whether the returned list of entries should include those that have been negated
+  @return {CodedEntryList} the matching entries
+  ###
+  match: (codeSet, start, end, includeNegated=false) ->
+    cloned = new hQuery.CodedEntryList()
+    for entry in this
+      afterStart = (!start || entry.timeStamp()>=start)
+      beforeEnd = (!end || entry.timeStamp()<=end)
+      if (afterStart && beforeEnd && entry.includesCodeFrom(codeSet) && (includeNegated || !entry.negationInd()))
+        cloned.push(entry)
+    cloned
+
+  ###*
+  Return a new list of entries that is the result of concatenating the passed in entries with this list
+  @return {CodedEntryList} the set of concatenated entries
+  ###
+  concat: (otherEntries) ->
+    cloned = new hQuery.CodedEntryList()
+    for entry in this
+      cloned.push entry
+    for entry in otherEntries
+      cloned.push entry
+    cloned
+
+  ###*
+  Match entries with the specified statuses
+  @return {CodedEntryList} the matching entries
+  ###
+  withStatuses: (statuses, includeUndefined=true) ->
+    statuses = statuses.concat([undefined, null]) if includeUndefined
+    cloned = new hQuery.CodedEntryList()
+    for entry in this
+      cloned.push entry if entry.status() in statuses
+    cloned
+
+  ###*
+  Filter entries based on negation
+  @param {Object} codeSet a hash with code system names as keys and an array of codes as values
+  @return {CodedEntryList} negated entries
+  ###
+  withNegation: (codeSet) ->
+    cloned = new hQuery.CodedEntryList()
+    for entry in this
+      cloned.push entry if entry.negationInd() && (!codeSet || (entry.negationReason() && entry.negationReason().includedIn(codeSet)))
+    cloned
+
+  ###*
+  Filter entries based on negation
+  @return {CodedEntryList} non-negated entries
+  ###
+  withoutNegation: ->
+    cloned = new hQuery.CodedEntryList()
+    for entry in this
+      cloned.push entry if !entry.negationInd()
+    cloned
+
+###*
+@private
+@function
+
+###
+hQuery.createCodedValues = (jsonCodes) ->
+  codedValues = []
+  for codeSystem, codes of jsonCodes
+    for code in codes
+      codedValues.push new hQuery.CodedValue code, codeSystem
+  codedValues
+
+