fhir_client 3.0.2 → 3.0.3

data/Gemfile

@@ -8,6 +8,6 @@ gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', require: nil
-  gem 'rubocop', '~> 0.43.0', require: false
+  gem 'rubocop', '~> 0.49.0', require: false
   gem 'awesome_print', require: 'ap'
 end

data/README.md

@@ -3,7 +3,7 @@
 Ruby FHIR client.
 
 Supports:
-* FHIR STU3
+* FHIR STU3 and DSTU2
 * XML and JSON
 * All CRUD, including version read and history
 * Transactions and Batches
@@ -40,11 +40,14 @@ patient = FHIR::Patient.read('example')
 
 # update a patient
 patient.gender = 'female'
-patient.update # saves the patient 
+patient.update # saves the patient
 
 # create a patient
 patient = FHIR::Patient.create(name: {given: 'John', family: 'Doe'})
 
+#create a patient with specific headers
+patient = FHIR::Patient.new(name: {given: 'John', family: 'Doe'}).create({Prefer: "return=representation"})
+
 # search patients
 results = FHIR::Patient.search(given: 'John', family: 'Doe')
 results.count # results in an enumeration
@@ -55,6 +58,32 @@ patient.destroy
 
 ## Advanced Usage
 
+### STU3 and DSTU2
+The client defaults to `STU3` but can be switched to `DSTU2` or it can also attempt to autodetect the FHIR version based on the `metadata` endpoint.
+
+```ruby
+# autodetect the FHIR version
+client = FHIR::Client.new(url)
+version = client.detect_version
+if version == :stu3
+  puts 'FHIR Client using STU3'
+elsif version == :dstu2
+  puts 'FHIR Client using DSTU2'
+end
+
+# tell the client to use STU3 (default)
+client.use_stu3
+# now use the client normally
+patient = FHIR::Patient.read('example')
+patient = client.read(FHIR::Patient, 'example').resource
+
+# tell the client to use DSTU2
+client.use_dstu2
+# now use the client with the DSTU2 models
+patient = FHIR::DSTU2::Patient.read('example')
+patient = client.read(FHIR::DSTU2::Patient, 'example').resource
+```
+
 ### CRUD Examples
 ```ruby
 # read an existing patient with id "example"

data/fhir_client.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'addressable', '>= 2.3'
-  spec.add_dependency 'fhir_models', '>= 3.0.0'
+  spec.add_dependency 'fhir_models', '>= 3.0.2'
+  spec.add_dependency 'fhir_dstu2_models', '>= 1.0.3'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'oauth2', '~> 1.1'
   spec.add_dependency 'rack', '>= 1.5'

data/lib/fhir_client.rb

@@ -1,4 +1,5 @@
 require 'fhir_models'
+require 'fhir_dstu2_models'
 require 'active_support/all'
 
 root = File.expand_path '.', File.dirname(File.absolute_path(__FILE__))

data/lib/fhir_client/client.rb

@@ -21,7 +21,7 @@ module FHIR
     attr_accessor :client
 
     attr_accessor :default_format
-
+    attr_accessor :fhir_version
     attr_accessor :cached_capability_statement
 
     # Call method to initialize FHIR client. This method must be invoked
@@ -36,15 +36,63 @@ module FHIR
       FHIR.logger.info "Initializing client with #{@base_service_url}"
       @use_format_param = false
       @default_format = default_format
+      @fhir_version = :stu3
       set_no_auth
     end
 
     def default_json
-      @default_format = FHIR::Formats::ResourceFormat::RESOURCE_JSON
+      @default_format = if @fhir_version == :stu3
+                          FHIR::Formats::ResourceFormat::RESOURCE_JSON
+                        else
+                          FHIR::Formats::ResourceFormat::RESOURCE_JSON_DSTU2
+                        end
     end
 
     def default_xml
-      @default_format = FHIR::Formats::ResourceFormat::RESOURCE_XML
+      @default_format = if @fhir_version == :stu3
+                          FHIR::Formats::ResourceFormat::RESOURCE_XML
+                        else
+                          FHIR::Formats::ResourceFormat::RESOURCE_XML_DSTU2
+                        end
+    end
+
+    def use_stu3
+      @fhir_version = :stu3
+      @default_format = if @default_format.include?('xml')
+                          FHIR::Formats::ResourceFormat::RESOURCE_XML
+                        else
+                          FHIR::Formats::ResourceFormat::RESOURCE_JSON
+                        end
+    end
+
+    def use_dstu2
+      @fhir_version = :dstu2
+      @default_format = if @default_format.include?('xml')
+                          FHIR::Formats::ResourceFormat::RESOURCE_XML_DSTU2
+                        else
+                          FHIR::Formats::ResourceFormat::RESOURCE_JSON_DSTU2
+                        end
+    end
+
+    def versioned_resource_class(klass)
+      if @fhir_version == :stu3
+        FHIR.const_get(klass)
+      else
+        FHIR::DSTU2.const_get(klass)
+      end
+    end
+
+    def detect_version
+      cap = capability_statement
+      if cap.is_a?(FHIR::CapabilityStatement)
+        @fhir_version = :stu3
+      elsif cap.is_a?(FHIR::DSTU2::Conformance)
+        @fhir_version = :dstu2
+      else
+        @fhir_version = :stu3
+      end
+      FHIR.logger.info("Detecting server FHIR version as #{@fhir_version} via metadata")
+      @fhir_version
     end
 
     # Set the client to use no authentication mechanisms
@@ -189,9 +237,22 @@ module FHIR
       formats.each do |frmt|
         reply = get 'metadata', fhir_headers(format: frmt)
         next unless reply.code == 200
-        @cached_capability_statement = parse_reply(FHIR::CapabilityStatement, frmt, reply)
-        @default_format = frmt
-        break
+        begin
+          @cached_capability_statement = parse_reply(FHIR::CapabilityStatement, frmt, reply)
+        rescue
+          @cached_capability_statement = nil
+        end
+        unless @cached_capability_statement
+          begin
+            @cached_capability_statement = parse_reply(FHIR::DSTU2::Conformance, frmt, reply)
+          rescue
+            @cached_capability_statement = nil
+          end
+        end
+        if @cached_capability_statement
+          @default_format = frmt
+          break
+        end
       end
       @default_format = default_format if @default_format.nil?
       @default_format
@@ -210,16 +271,28 @@ module FHIR
     end
 
     def parse_reply(klass, format, response)
-      FHIR.logger.info "Parsing response with {klass: #{klass}, format: #{format}, code: #{response.code}}."
+      FHIR.logger.debug "Parsing response with {klass: #{klass}, format: #{format}, code: #{response.code}}."
       return nil unless [200, 201].include? response.code
       res = nil
       begin
-        res = FHIR.from_contents(response.body)
+        res = if(@fhir_version == :dstu2 || klass.ancestors.include?(FHIR::DSTU2::Model))
+                if(format.include?('xml'))
+                  FHIR::DSTU2::Xml.from_xml(response.body)
+                else
+                  FHIR::DSTU2::Json.from_json(response.body)
+                end
+              else
+                if(format.include?('xml'))
+                  FHIR::Xml.from_xml(response.body)
+                else
+                  FHIR::Json.from_json(response.body)
+                end
+              end
         res.client = self unless res.nil?
         FHIR.logger.warn "Expected #{klass} but got #{res.class}" if res.class != klass
       rescue => e
-        FHIR.logger.error "Failed to parse #{format} as resource #{klass}: #{e.message} %n #{e.backtrace.join("\n")} #{response}"
-        nil
+        FHIR.logger.error "Failed to parse #{format} as resource #{klass}: #{e.message}"
+        res = nil
       end
       res
     end
@@ -232,7 +305,13 @@ module FHIR
       if [:get, :delete, :head].include?(request['method'])
         method(request['method']).call(request['url'], request['headers'])
       elsif [:post, :put].include?(request['method'])
-        resource = FHIR.from_contents(request['payload']) unless request['payload'].nil?
+        unless request['payload'].nil?
+          resource = if @fhir_version == :stu3
+                       FHIR.from_contents(request['payload'])
+                     else
+                       FHIR::DSTU2.from_contents(request['payload'])
+                     end
+        end
         method(request['method']).call(request['url'], resource, request['headers'])
       end
     end
@@ -308,6 +387,12 @@ module FHIR
         begin
           response = @client.get(url, headers: headers)
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "GET - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           response = e.response if e.response
         end
         req = {
@@ -323,11 +408,11 @@ module FHIR
           body: response.body
         }
         if url.end_with?('/metadata')
-          FHIR.logger.info "GET - Request: #{req}, Response: [too large]"
+          FHIR.logger.debug "GET - Request: #{req}, Response: [too large]"
         else
-          FHIR.logger.info "GET - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
+          FHIR.logger.debug "GET - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
         end
-        @reply = FHIR::ClientReply.new(req, res)
+        @reply = FHIR::ClientReply.new(req, res, self)
       else
         headers.merge!(@security_headers) if @use_basic_auth
         begin
@@ -346,15 +431,21 @@ module FHIR
             headers: nil,
             body: sslerr.message
           }
-          @reply = FHIR::ClientReply.new(req, res)
+          @reply = FHIR::ClientReply.new(req, res, self)
           return @reply
         rescue => e
-          response = e.response if e.response
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "GET - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
+          response = e.response
         end
         if url.end_with?('/metadata')
-          FHIR.logger.info "GET - Request: #{response.request.to_json}, Response: [too large]"
+          FHIR.logger.debug "GET - Request: #{response.request.to_json}, Response: [too large]"
         else
-          FHIR.logger.info "GET - Request: #{response.request.to_json}, Response: #{response.body.force_encoding('UTF-8')}"
+          FHIR.logger.debug "GET - Request: #{response.request.to_json}, Response: #{response.body.force_encoding('UTF-8')}"
         end
         response.request.args[:path] = response.request.args[:url].gsub(@base_service_url, '')
         headers = response.headers.each_with_object({}) { |(k, v), h| h[k.to_s.tr('_', '-')] = v.to_s; h }
@@ -364,7 +455,7 @@ module FHIR
           body: response.body
         }
 
-        @reply = FHIR::ClientReply.new(response.request.args, res)
+        @reply = FHIR::ClientReply.new(response.request.args, res, self)
       end
     end
 
@@ -378,6 +469,12 @@ module FHIR
         begin
           response = @client.post(url, headers: headers, body: payload)
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "POST - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           response = e.response if e.response
         end
         req = {
@@ -392,19 +489,19 @@ module FHIR
           headers: response.headers,
           body: response.body
         }
-        FHIR.logger.info "POST - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
-        @reply = FHIR::ClientReply.new(req, res)
+        FHIR.logger.debug "POST - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
+        @reply = FHIR::ClientReply.new(req, res, self)
       else
         headers.merge!(@security_headers) if @use_basic_auth
         @client.post(url, payload, headers) do |resp, request, result|
-          FHIR.logger.info "POST - Request: #{request.to_json}\nResponse:\nResponse Headers: #{scrubbed_response_headers(result.each_key {})} \nResponse Body: #{resp.force_encoding('UTF-8')}"
+          FHIR.logger.debug "POST - Request: #{request.to_json}\nResponse:\nResponse Headers: #{scrubbed_response_headers(result.each_key {})} \nResponse Body: #{resp.force_encoding('UTF-8')}"
           request.args[:path] = url.gsub(@base_service_url, '')
           res = {
             code: result.code,
             headers: scrubbed_response_headers(result.each_key {}),
             body: resp
           }
-          @reply = FHIR::ClientReply.new(request.args, res)
+          @reply = FHIR::ClientReply.new(request.args, res, self)
         end
       end
     end
@@ -419,6 +516,12 @@ module FHIR
         begin
           response = @client.put(url, headers: headers, body: payload)
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "PUT - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           response = e.response if e.response
         end
         req = {
@@ -433,19 +536,19 @@ module FHIR
           headers: response.headers,
           body: response.body
         }
-        FHIR.logger.info "PUT - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
-        @reply = FHIR::ClientReply.new(req, res)
+        FHIR.logger.debug "PUT - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
+        @reply = FHIR::ClientReply.new(req, res, self)
       else
         headers.merge!(@security_headers) if @use_basic_auth
         @client.put(url, payload, headers) do |resp, request, result|
-          FHIR.logger.info "PUT - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
+          FHIR.logger.debug "PUT - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
           request.args[:path] = url.gsub(@base_service_url, '')
           res = {
             code: result.code,
             headers: scrubbed_response_headers(result.each_key {}),
             body: resp
           }
-          @reply = FHIR::ClientReply.new(request.args, res)
+          @reply = FHIR::ClientReply.new(request.args, res, self)
         end
       end
     end
@@ -460,6 +563,12 @@ module FHIR
         begin
           response = @client.patch(url, headers: headers, body: payload)
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "PATCH - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           response = e.response if e.response
         end
         req = {
@@ -474,22 +583,28 @@ module FHIR
           headers: response.headers,
           body: response.body
         }
-        FHIR.logger.info "PATCH - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
-        @reply = FHIR::ClientReply.new(req, res)
+        FHIR.logger.debug "PATCH - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
+        @reply = FHIR::ClientReply.new(req, res, self)
       else
         headers.merge!(@security_headers) if @use_basic_auth
         begin
           @client.patch(url, payload, headers) do |resp, request, result|
-            FHIR.logger.info "PATCH - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
+            FHIR.logger.debug "PATCH - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
             request.args[:path] = url.gsub(@base_service_url, '')
             res = {
               code: result.code,
               headers: scrubbed_response_headers(result.each_key {}),
               body: resp
             }
-            @reply = FHIR::ClientReply.new(request.args, res)
+            @reply = FHIR::ClientReply.new(request.args, res, self)
           end
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "PATCH - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           req = {
             method: :patch,
             url: url,
@@ -500,8 +615,9 @@ module FHIR
           res = {
             body: e.message
           }
+          FHIR.logger.debug "PATCH - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
           FHIR.logger.error "PATCH Error: #{e.message}"
-          @reply = FHIR::ClientReply.new(req, res)
+          @reply = FHIR::ClientReply.new(req, res, self)
         end
       end
     end
@@ -515,6 +631,12 @@ module FHIR
         begin
           response = @client.delete(url, headers: headers)
         rescue => e
+          unless e.response
+            # Re-raise the client error if there's no response. Otherwise, logging
+            # and other things break below!
+            FHIR.logger.error "DELETE - Request: #{url} failed! No response from server: #{e}"
+            raise # Re-raise the same error we caught.
+          end
           response = e.response if e.response
         end
         req = {
@@ -529,19 +651,19 @@ module FHIR
           headers: response.headers,
           body: response.body
         }
-        FHIR.logger.info "DELETE - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
-        @reply = FHIR::ClientReply.new(req, res)
+        FHIR.logger.debug "DELETE - Request: #{req}, Response: #{response.body.force_encoding('UTF-8')}"
+        @reply = FHIR::ClientReply.new(req, res, self)
       else
         headers.merge!(@security_headers) if @use_basic_auth
         @client.delete(url, headers) do |resp, request, result|
-          FHIR.logger.info "DELETE - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
+          FHIR.logger.debug "DELETE - Request: #{request.to_json}, Response: #{resp.force_encoding('UTF-8')}"
           request.args[:path] = url.gsub(@base_service_url, '')
           res = {
             code: result.code,
             headers: scrubbed_response_headers(result.each_key {}),
             body: resp
           }
-          @reply = FHIR::ClientReply.new(request.args, res)
+          @reply = FHIR::ClientReply.new(request.args, res, self)
         end
       end
     end
@@ -551,14 +673,14 @@ module FHIR
       url = URI(build_url(path)).to_s
       FHIR.logger.info "HEADING: #{url}"
       RestClient.head(url, headers) do |response, request, result|
-        FHIR.logger.info "HEAD - Request: #{request.to_json}, Response: #{response.force_encoding('UTF-8')}"
+        FHIR.logger.debug "HEAD - Request: #{request.to_json}, Response: #{response.force_encoding('UTF-8')}"
         request.args[:path] = url.gsub(@base_service_url, '')
         res = {
           code: result.code,
           headers: scrubbed_response_headers(result.each_key {}),
           body: response
         }
-        @reply = FHIR::ClientReply.new(request.args, res)
+        @reply = FHIR::ClientReply.new(request.args, res, self)
       end
     end