allscripts_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d2ee397a4c9ecf45e7a20fa6a3cd5e7cad43c77
-  data.tar.gz: 80b8b4c04c0fe2c585c0fa5b7a935a71d36a4826
+  metadata.gz: 315aedfaf84044bf6676dba411e2c73f5693aa0e
+  data.tar.gz: 4d37e4ebba1d080edb9766e80dbb672dae232fd8
 SHA512:
-  metadata.gz: 80dda6414b9382877ea4abce74f14505d04b901253282df42939ff59c1c4898977434ae009ce85a05168cd7a79dc190397ab8044fc2904e6c2cd1e37e0538729
-  data.tar.gz: fae98f28f8f2d1da1e59fb908f5ccff36d4b7f90b69175ff948431cf983abdd861bc71d882a3fc2971376b71f9e782358283ed05af71c60b78d20eef0c358371
+  metadata.gz: 1215aeb29079a1a44e68c07762cb52f2e3132e0d57666574d30a43a49f04dd015c2833157eecfda9e9f964cfc06125b6b82ffd4cf55e7cfcc45c300734db3bae
+  data.tar.gz: 2a12b36abd1eca7dddef706a0fdd96726c4500c4ee55af2e166a43aadfc3e3e0f4e650ac576dbbb359a74f759b5520ce1ae2622677c19c2e8fb78709251bc826

data/.pryrc

@@ -1,5 +1,8 @@
 require "allscripts_api"
 require "yaml"
+require "awesome_print"
+AwesomePrint.pry!
+AwesomePrint.defaults = { raw: true }
 
 begin
   loaded = ENV["app_name"] && ENV["app_password"] && ENV["unity_url"] && ENV["app_username"]

data/.rubocop.yml

@@ -17,6 +17,12 @@ Style/AccessorMethodName:
 # Bumbing the max from 10 to 15 allows magic params to work nicely
 Metrics/MethodLength:
   Max: 15
+  Exclude:
+    - "lib/allscripts_api/order.rb"
 # Bumbing the max from 5 to 7 allows magic params to work nicely
 Metrics/ParameterLists:
-  Max: 7
+  Max: 7
+
+Metrics/AbcSize:
+  Exclude:
+    - "lib/allscripts_api/order.rb"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    allscripts_api (0.3.0)
+    allscripts_api (0.4.0)
       faraday (>= 0.12.2)
 
 GEM
@@ -10,6 +10,9 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.3.0)
+    awesome_print (1.7.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
     coderay (1.1.2)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
@@ -19,6 +22,7 @@ GEM
       tins (~> 1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    debug_inspector (0.0.2)
     diff-lcs (1.3)
     docile (1.1.5)
     faraday (0.14.0)
@@ -29,6 +33,7 @@ GEM
     hashdiff (0.3.7)
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
+    interception (0.5)
     json (2.1.0)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
@@ -55,6 +60,15 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-doc (0.13.4)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    pry-rescue (1.4.4)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
     public_suffix (3.0.2)
     rainbow (2.2.2)
       rake
@@ -108,12 +122,16 @@ PLATFORMS
 
 DEPENDENCIES
   allscripts_api!
+  awesome_print
   bundler (~> 1.16)
   coveralls
   nokogiri
   pronto
   pronto-rubocop
   pry
+  pry-doc
+  pry-rescue
+  pry-stack_explorer
   rake (~> 10.0)
   rspec (~> 3.0)
   webmock (~> 3.3)

data/README.md

@@ -1,5 +1,5 @@
 # AllscriptsApi, an Allscripts Unity Client
-
+[![Gem Version](https://badge.fury.io/rb/allscripts_api.svg)](https://badge.fury.io/rb/allscripts_api)
 [![Coverage Status](https://coveralls.io/repos/github/Avhana/allscripts_api/badge.svg?branch=master)](https://coveralls.io/github/Avhana/allscripts_api?branch=master)
 [![Build Status](https://travis-ci.org/Avhana/allscripts_api.svg?branch=master)](https://travis-ci.org/Avhana/allscripts_api)
 [![Inline docs](http://inch-ci.org/github/Avhana/allscripts_api.svg?branch=master&style=shields)](http://inch-ci.org/github/Avhana/allscripts_api)

data/allscripts_api.gemspec

@@ -23,12 +23,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", ">= 0.12.2"
+  spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "nokogiri"
   spec.add_development_dependency "pronto"
   spec.add_development_dependency "pronto-rubocop"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry-stack_explorer"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "yard", "~> 0.9"

data/lib/allscripts_api.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-
+require "nokogiri"
 require "allscripts_api/configuration"
 require "allscripts_api/magic_params"
 require "allscripts_api/named_magic_methods"
+require "allscripts_api/ordering_methods"
+require "allscripts_api/order"
 require "allscripts_api/client"
 require "allscripts_api/version"
 
@@ -36,7 +38,7 @@ module AllscriptsApi
   class << self
     attr_accessor :configuration
     # a method that allows a configuration block to be passed
-    # to {AllscriptsApi::Configuration#new}
+    # to AllscriptsApi::Configuration#new
     # @see AllscriptsApi::Configuration
     def configure
       self.configuration ||= AllscriptsApi::Configuration.new

data/lib/allscripts_api/client.rb

@@ -6,6 +6,7 @@ module AllscriptsApi
   # Client serves as an entry point for making calls
   class Client
     include AllscriptsApi::NamedMagicMethods
+    include AllscriptsApi::OrderingMethods
     attr_reader :adapter, :unity_url, :app_name, :token
     attr_writer :sso_token
 
@@ -86,7 +87,6 @@ module AllscriptsApi
           req.url(full_path)
           req.body = body
         end
-
       read_magic_response(response)
     end
 

data/lib/allscripts_api/named_magic_methods.rb

@@ -104,6 +104,27 @@ module AllscriptsApi
       results["getpatientinfo"]
     end
 
+    # gets patient's demographic info, insurance, guarantor, and PCP info
+    # Note that this method is litely to return blank data sets 
+    # for invalid IDs rather than raising an error
+    #
+    # @param patient_id [String] patient id
+    # @param mrn [String|nil] medical record number, if patient id is unknown
+    # @parma order_id [String|nil] optionally used to get info for a secific
+    # patient order
+    # @return [String, AllscriptsApi::MagicError] patient demographics
+    def get_patient_full(patient_id, mrn = nil, order_id = nil)
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          patient_id: patient_id,
+          parameter1: mrn,
+          parameter2: order_id
+        )
+      results = magic("GetPatientFull", magic_params: params)
+      results["getpatientfullinfo"]
+    end
+
     # a wrapper around GetPatientProblems
     #
     # @param patient_id [String] patient id
@@ -150,6 +171,24 @@ module AllscriptsApi
       results["getscheduleinfo"]
     end
 
+    def get_encounter_list(patient_id = "", encounter_type = "",
+                           when_or_limit = "", nostradamus = 0,
+                           show_past_flag = "Y",
+                           billing_provider_user_name = "")
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          patient_id: patient_id,
+          parameter1: encounter_type, # from Encounter_Type_DE
+          parameter2: when_or_limit,
+          parameter3: nostradamus,
+          parameter4: show_past_flag,
+          parameter5: billing_provider_user_name,
+        )
+      results = magic("GetEncounterList", magic_params: params)
+      results["getencounterlistinfo"]
+    end
+
     # a wrapper around GetListOfDictionaries, which returns
     # list of all dictionaries
     #

data/lib/allscripts_api/order.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # A value object wrapped around a `Nokogiri::XML::Builder` DSL that builds
+  # properly formatted XML for `AllscriptsApi::OrderingMEthods.save_order`
+  class Order
+    # Builder method for returning XML
+    #
+    # @param site_id [String] the id for the Allscripts install site
+    # @param emr_user_id [String] the provider's Allscripts id
+    # @param order_date [DateTime] a date for the order (Typically today)
+    # @param encounter_id [String|Nil] an encounter id, used when
+    # ordering to current encounter
+    # @return [String] xml formatted for
+    # {AllscriptsApi::OrderingMethods#save_order}
+    def self.build_xml(site_id, emr_user_id, order_date, encounter_id = "")
+      date = order_date.strftime("%d-%b-%Y")
+      builder = Nokogiri::XML::Builder.new
+      builder.saveorderxml do
+        # a value of 'Y' makes the order visible on the order list
+        builder.field("id" => "ordershowonorderlist", "value" => "Y")
+        builder.field("id" => "orderlocation", "value" => site_id)
+        builder.field("id" => "ordertobedone", "value" => date)
+        # default, not important, required
+        builder.field("id" => "orderpriority", "value" => "2")
+        builder.field("id" => "orderschedulefreetext", "value" => "")
+        builder.field("id" => "orderschedulerecurring", "value" => "")
+        builder.field("id" => "orderschedulerecurringperiod", "value" => "")
+        builder.field("id" => "orderschedulestarting", "value" => date)
+        builder.field("id" => "orderscheduleending", "value" => date)
+        builder.field("id" => "orderscheduleendingafter", "value" => "")
+        builder.field("id" => "orderperformingcomment", "value" => "")
+        builder.field("id" => "ordercommunicatedby", "value" => 11) # hard coded
+        builder.field("id" => "orderorderedby", "value" => emr_user_id)
+        builder.field("id" => "ordermanagedby", "value" => emr_user_id)
+        builder.field("id" => "ordersupervisedby", "value" => "")
+        builder.field("id" => "orderciteresult", "value" => "")
+        builder.field("id" => "orderannotation", "value" => "")
+        builder.field("id" => "orderstatus", "value" => "Active")
+        builder.field("id" => "orderstatusdate", "value" => date)
+        builder.field("id" => "orderdeferralinterval", "value" => 0)
+        builder.field("id" => "orderdeferralunit", "value" => "Days")
+        builder.field("id" => "orderstatusreason", "value" => "")
+        builder.field("id" => "encounter", "value" => encounter_id.to_s)
+        builder.orderlinkedproblems
+        builder.clinicalquestions
+      end
+
+      builder.to_xml
+    end
+  end
+end

data/lib/allscripts_api/ordering_methods.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # A collection convenience methods for ordering that map
+  # to Allscripts magic actions. Some of these methods
+  # wrap multiple actions. These methods are included
+  # in {AllscriptsApi::Client} and can be accessed from
+  # instances of that class.
+  module OrderingMethods
+    # a wrapper around SaveOrder, which save and order of the
+    # sepcified category, among: AdministeredMedication,
+    # Immunization, InstructionOrder, ProcedureOrder,
+    # Referral, SuppliesOrder.
+    #
+    # xml can be constructed with {AllscriptsApi::Order.build_xml}
+    #
+    # @param patient_id [String]
+    # @param xml [String] xml containing saveorderxml fields and values
+    # @param order_category [String] one of AdministeredMedication,
+    # Immunization, InstructionOrder, ProcedureOrder,
+    # Referral, SuppliesOrder.
+    # @param dictionary_id [String] id of the dictionary from SearchOrder TODO: look into how to doc this better
+    # @param problem_id [String|Nil] problem to associate with the order,
+    # may be passed in as part of the xml
+    # @param trans_id [String|Nil] the original OrderID,
+    # necessary when updating a past order
+    # @return [Hash|MagicError] order confirmation or error
+    def save_order(patient_id, xml, order_category, dictionary_id,
+                   problem_id = nil, trans_id = nil)
+      params = MagicParams.format(
+        user_id: @allscripts_username,
+        patient_id: patient_id,
+        parameter1: xml,
+        parameter2: order_category,
+        parameter3: dictionary_id,
+        parameter4: problem_id,
+        parameter5: trans_id
+      )
+      magic("SaveOrder", magic_params: params)
+    end
+  end
+end

data/lib/allscripts_api/version.rb

@@ -2,5 +2,5 @@
 
 module AllscriptsApi
   # gem version declaration
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allscripts_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chase
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +249,8 @@ files:
 - lib/allscripts_api/configuration.rb
 - lib/allscripts_api/magic_params.rb
 - lib/allscripts_api/named_magic_methods.rb
+- lib/allscripts_api/order.rb
+- lib/allscripts_api/ordering_methods.rb
 - lib/allscripts_api/version.rb
 homepage: https://github.com/Avhana/allscripts_api
 licenses: []
@@ -213,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A simple, configurable wrapper around Allscripts APIs