allscripts_api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06aaddd4e6fec0d855fe6b972ab0687a6e366b1
-  data.tar.gz: 3e8fd1b4de7d5c16acec8ae157aac9077ce460a3
+  metadata.gz: ae946e7adbf4299a037926c915fd33ff7bf57543
+  data.tar.gz: a2b9a11e36131641c5c338375a57d0decd12880c
 SHA512:
-  metadata.gz: 2e5809bc5ce6969a91e77f4c5c1324e6f82e701ccda52fc120234a4377e8003cad1a5615eebd062e6246af55bccfe1492c66f110dc2d54df134d14722db55949
-  data.tar.gz: acebaabdb10e84956fef21d943983826f92fc1ccb2c79e801f52f64c5b53c34c262bc6357c538da98ddfdbe0e2704223f1e8efde34b19feb95e5d4cd82fb03bd
+  metadata.gz: 24e68dfd0b893788d198956362c1f6c0f26bace7e3bcd18239f59e353595517c25ba09eaf774f48229c7257bc825f6b57abd03fdc53901da5745ef810f99e129
+  data.tar.gz: ca99389bd969d11db5bd789e7068dcce5e1a8e363ddf13909998cb7a3a2690ac079b63d114a0ccaca3881c2930f8796f82049726573e18f892221835a14d1613

data/.pryrc

@@ -27,16 +27,16 @@ def bc
   client
 end
 
-def document_params 
+def document_params(pdf)
   {
-    bytes_read: "0",
+    bytes_read: pdf.bytes.length,
     b_done_upload: false,
     document_var: "",
     patient_id: 19,
     owner_code: "TW0001",
     first_name: "Allison",
     last_name: "Allscripts",
-    document_type: "sEKG",   #document_type_de.entrycode value GetDictionary
+    document_type: "gwn_otfm",   #document_type_de.entrycode value GetDictionary
     organization_name: "New World Health"
   }
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    allscripts_api (0.6.0)
+    allscripts_api (0.7.0)
       faraday (>= 0.12.2)
 
 GEM

data/README.md

@@ -3,7 +3,6 @@
 [![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)
-[![Dependency Status](https://gemnasium.com/badges/github.com/Avhana/allscripts_api.svg)](https://gemnasium.com/github.com/Avhana/allscripts_api)
 [![Maintainability](https://api.codeclimate.com/v1/badges/9889f5255914a5fcbeb5/maintainability)](https://codeclimate.com/github/Avhana/allscripts_api/maintainability)
 [![security](https://hakiri.io/github/Avhana/allscripts_api/master.svg)](https://hakiri.io/github/Avhana/allscripts_api/master)
 

data/lib/allscripts_api.rb

@@ -5,8 +5,9 @@ require "allscripts_api/configuration"
 require "allscripts_api/utilities/validator"
 require "allscripts_api/magic_params"
 require "allscripts_api/named_magic_methods"
-require "allscripts_api/ordering_methods"
-require "allscripts_api/order"
+require "allscripts_api/orders"
+require "allscripts_api/patients"
+require "allscripts_api/demographics"
 require "allscripts_api/documents"
 require "allscripts_api/client"
 require "allscripts_api/version"

data/lib/allscripts_api/client.rb

@@ -6,7 +6,9 @@ module AllscriptsApi
   # Client serves as an entry point for making calls
   class Client
     include AllscriptsApi::NamedMagicMethods
-    include AllscriptsApi::OrderingMethods
+    include AllscriptsApi::Orders::OrderingMethods
+    include AllscriptsApi::Patients::PatientMethods
+    include AllscriptsApi::Demographics::DemographicsMethods
     include AllscriptsApi::Documents::DocumentMethods
     attr_reader :adapter, :unity_url, :app_name, :token
     attr_writer :sso_token

data/lib/allscripts_api/demographics.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "allscripts_api/demographics/demographics_methods"

data/lib/allscripts_api/demographics/demographics_methods.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  module Demographics
+    # A collection convenience methods for ordering that map
+    # to Allscripts magic actions related to demographics calls.
+    # These methods are included in {AllscriptsApi::Client}
+    # and can be accessed from instances of that class.
+    module DemographicsMethods
+      # a wrapper around SearchPatients
+      #
+      # @param search_string [String] may be a name, birthdate
+      #   partial address, or other PHI
+      # @return [Array<Hash>, Array, MagicError] a list of found patients,
+      #   an empty array, or an error
+      def search_patients(search_string)
+        params =
+          MagicParams.format(
+            user_id: @allscripts_username,
+            parameter1: search_string
+          )
+        results = magic("SearchPatients", magic_params: params)
+        results["searchpatientsinfo"]
+      end
+
+      # gets patient's demographic info, insurance, guarantor, and PCP info
+      #
+      # @param patient_id [String] patient id
+      # @param patient_number [String] PM patient number
+      # @return [String, AllscriptsApi::MagicError] patient demographics
+      def get_patient(patient_id, patient_number = nil)
+        params =
+          MagicParams.format(
+            user_id: @allscripts_username,
+            patient_id: patient_id,
+            parameter1: patient_number
+          )
+        results = magic("GetPatient", magic_params: params)
+        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
+      # @param 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
+    end
+  end
+end

data/lib/allscripts_api/documents/document.rb

@@ -18,7 +18,7 @@ module AllscriptsApi
       # @param command [String] i for insert, e for delete (entered in error), u for update
       # @param params [Hash] any other params you may wish to pass to the api
       # params may look like the following, all of which are required:
-      # @option params [String] :bytes_read number of bytes in the chunk (use 0 for 1 big chunk)
+      # @option params [String] :bytes_read number of bytes in the chunk (pdf.bytes.length is nice for this if using one big chunk)
       # @option params [String] :b_done_upload should be passed in as false,
       # @option params [String] :document_var should be empty unless you are saving or updating
       # @option params [String] :patient_id

data/lib/allscripts_api/documents/document_methods.rb

@@ -29,6 +29,39 @@ module AllscriptsApi
         results = magic("SaveDocumentImage", magic_params: params)
         results["savedocumentimageinfo"]
       end
+
+      # gets the CCDA documents for the specified patient and encounter
+      #
+      # @param patient_id [String] patient id
+      # @param encounter_id [String] encounter id from which to generate the CCDA
+      # @param org_id [String] specifies the organization, by default Unity
+      # uses the organization for the specified user
+      # @param app_group [String] defaults to "TouchWorks"
+      # @param referral_text [String] contents of ReferralText are appended
+      # @param site_id [String] site id
+      # @param document_type [String] document type defaults to CCDACCD,
+      # CCDACCD (Default) - Returns the Continuity of Care Document. This
+      # is the default behavior if nothing is passed in.
+      # CCDASOC - Returns the Summary of Care Document
+      # CCDACS - Returns the Clinical Summary Document (Visit Summary).
+      # @return [String, AllscriptsApi::MagicError] ccda for patient
+      def get_ccda(patient_id, encounter_id, org_id = nil,
+                   app_group = nil, referral_text = nil,
+                   site_id = nil, document_type = "CCDACCD")
+        params =
+          MagicParams.format(
+            user_id: @allscripts_username,
+            patient_id: patient_id,
+            parameter1: encounter_id,
+            parameter2: org_id,
+            parameter3: app_group,
+            parameter4: referral_text,
+            parameter5: site_id,
+            parameter6: document_type
+          )
+        results = magic("GetCCDA", magic_params: params)
+        results["getccdainfo"][0]["ccdaxml"]
+      end
     end
   end
 end

data/lib/allscripts_api/documents/document_sender.rb

@@ -5,6 +5,7 @@ module AllscriptsApi
     # Wraps {AllscriptsApi::Documents::Document.build_xml} and
     # {AllscriptsApi::Documents::DocumentMethods#save_document_image}
     # to handle the 2 step document image saving process
+    # The DocumentSender is set up to send the document as one big chunk
     class DocumentSender
       # rubocop:disable LineLength
       # The new method sets up eerything needed to run {#send_document}
@@ -12,7 +13,7 @@ module AllscriptsApi
       # @example Usage Example
       #   document_params =
       #     {
-      #       bytes_read: "0",
+      #       bytes_read: pdf.bytes.length,
       #       b_done_upload: false,
       #       document_var: "",
       #       patient_id: 19,
@@ -29,7 +30,7 @@ module AllscriptsApi
       # @param document [String] the string contents of the pdf to be saved
       # @param file_name [String] the name of the file to be saved, usually ending in .pdf
       # @param params [Hash] a hash of params for use in saving a document
-      # @see {AllscriptsApi::Dpcuments::DocumentSender} for details
+      # @see {AllscriptsApi::Documents::DocumentSender} for details
       # @return [AllscriptsApi::Documents::DocumentSender]
       # rubocop:enable LineLength
       def initialize(client, document, file_name, params)

data/lib/allscripts_api/named_magic_methods.rb

@@ -6,22 +6,6 @@ module AllscriptsApi
   # in `AllscriptsApi::Client` and can be accessed from
   # instances of that class.
   module NamedMagicMethods
-    # a wrapper around SearchPatients
-    #
-    # @param search_string [String] may be a name, birthdate
-    #   partial address, or other PHI
-    # @return [Array<Hash>, Array, MagicError] a list of found patients,
-    #   an empty array, or an error
-    def search_patients(search_string)
-      params =
-        MagicParams.format(
-          user_id: @allscripts_username,
-          parameter1: search_string
-        )
-      results = magic("SearchPatients", magic_params: params)
-      results["searchpatientsinfo"]
-    end
-
     # a wrapper around GetProvider
     #
     # @param provider_id [String] optional Allscripts user id
@@ -37,109 +21,6 @@ module AllscriptsApi
       results["getproviderinfo"]
     end
 
-    # gets the CCDA documents for the specified patient and encounter
-    #
-    # @param patient_id [String] patient id
-    # @param encounter_id [String] encounter id from which to generate the CCDA
-    # @param org_id [String] specifies the organization, by default Unity
-    # uses the organization for the specified user
-    # @param app_group [String] defaults to "TouchWorks"
-    # @param referral_text [String] contents of ReferralText are appended
-    # @param site_id [String] site id
-    # @param document_type [String] document type defaults to CCDACCD,
-    # CCDACCD (Default) - Returns the Continuity of Care Document. This
-    # is the default behavior if nothing is passed in.
-    # CCDASOC - Returns the Summary of Care Document
-    # CCDACS - Returns the Clinical Summary Document (Visit Summary).
-    # @return [String, AllscriptsApi::MagicError] ccda for patient
-    def get_ccda(patient_id,
-                 encounter_id,
-                 org_id = nil,
-                 app_group = nil,
-                 referral_text = nil,
-                 site_id = nil,
-                 document_type = "CCDACCD")
-      params =
-        MagicParams.format(
-          user_id: @allscripts_username,
-          patient_id: patient_id,
-          parameter1: encounter_id,
-          parameter2: org_id,
-          parameter3: app_group,
-          parameter4: referral_text,
-          parameter5: site_id,
-          parameter6: document_type
-        )
-      results = magic("GetCCDA", magic_params: params)
-      results["getccdainfo"][0]["ccdaxml"]
-    end
-
-    # gets data elements of a patient's history
-    #
-    # @param patient_id [String] patient id
-    # @param section [String] section
-    # if no section is specified than all sections wt data are returned
-    # list multiple sections by using a pipe-delimited list ex. "Vitals|Alerts"
-    # @param encounter_id [String] internal identifier for the encounter
-    # the EncounterID can be acquired with GetEncounterList
-    # @param verbose [String] XMLDetail
-    # verbose column will be Y or blank, when Y is provided there will be a
-    # piece of XML data that is specific to that element of the patient's chart
-    # @return [String, AllscriptsApi::MagicError] clinical summary for patient
-    def get_clinical_summary(patient_id,
-                             section = nil,
-                             encounter_id = nil,
-                             verbose = nil)
-      params =
-        MagicParams.format(
-          user_id: @allscripts_username,
-          patient_id: patient_id,
-          parameter1: section,
-          parameter2: encounter_id,
-          parameter3: verbose
-        )
-      results = magic("GetClinicalSummary", magic_params: params)
-      results["getclinicalsummaryinfo"]
-    end
-
-    # gets patient's demographic info, insurance, guarantor, and PCP info
-    #
-    # @param patient_id [String] patient id
-    # @param patient_number [String] PM patient number
-    # @return [String, AllscriptsApi::MagicError] patient demographics
-    def get_patient(patient_id,
-                    patient_number = nil)
-      params =
-        MagicParams.format(
-          user_id: @allscripts_username,
-          patient_id: patient_id,
-          parameter1: patient_number
-        )
-      results = magic("GetPatient", magic_params: params)
-      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
-    # @param 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

data/lib/allscripts_api/orders.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "allscripts_api/orders/ordering_methods"
+require "allscripts_api/orders/order"

data/lib/allscripts_api/orders/order.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  module Orders
+    # A value object wrapped around a Nokogiri::XML::Builder DSL that builds
+    # properly formatted XML for {AllscriptsApi::OrderingMethods#save_order}
+    # @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Builder
+    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
+end

data/lib/allscripts_api/orders/ordering_methods.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  module Orders
+    # 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
+end

data/lib/allscripts_api/patients.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "allscripts_api/patients/patient_methods"

data/lib/allscripts_api/patients/patient_methods.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  module Patients
+    # A collection convenience methods for ordering that map
+    # to Allscripts magic actions related to patients.
+    # These methods are included in {AllscriptsApi::Client} 
+    # and can be accessed from instances of that class.
+    module PatientMethods
+      # gets data elements of a patient's history
+      #
+      # @param patient_id [String] patient id
+      # @param section [String] section
+      #   if no section is specified than all sections wt data are returned
+      #   list multiple sections by using a pipe-delimited list ex. "Vitals|Alerts"
+      # @param encounter_id [String] internal identifier for the encounter
+      #   the EncounterID can be acquired with GetEncounterList
+      # @param verbose [String] XMLDetail
+      #   verbose column will be Y or blank, when Y is provided there will be a
+      #   piece of XML data that is specific to that element of the patient's chart
+      # @return [String, AllscriptsApi::MagicError] clinical summary for patient
+      def get_clinical_summary(patient_id,
+                               section = nil,
+                               encounter_id = nil,
+                               verbose = nil)
+        params =
+          MagicParams.format(
+            user_id: @allscripts_username,
+            patient_id: patient_id,
+            parameter1: section,
+            parameter2: encounter_id,
+            parameter3: verbose
+          )
+        results = magic("GetClinicalSummary", magic_params: params)
+        results["getclinicalsummaryinfo"]
+      end
+
+      # Returns a list of Patient IDs whose information has been
+      #   modified since a timestamp
+      #
+      # @param patient_id [String] patient id
+      # @param since [DateTime]  DateTime indicating how far back to
+      #   query for changed patients.
+      # @param clinical_data_only [String] Indicates whether to
+      #   look at only changes in clinical data. Y or N
+      # @param verbose [String] Do you want to see the specific areas that have changed
+      # @param quick_scan [String] Set to Y to enable new change patient scanning functionality.
+      # @return [String, AllscriptsApi::MagicError] changed data for patient
+      def get_changed_patients(patient_id, since,
+                               clinical_data_only = "Y",
+                               verbose = "Y", quick_scan = "N")
+        params =
+          MagicParams.format(
+            user_id: @allscripts_username,
+            patient_id: patient_id,
+            parameter1: since.strftime("%m/%d/%Y"),
+            parameter2: clinical_data_only,
+            parameter3: verbose,
+            parameter4: quick_scan
+          )
+
+        results = magic("GetChangedPatients", magic_params: params)
+        results["getchangedpatientsinfo"]
+      end
+    end
+  end
+end

data/lib/allscripts_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allscripts_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chase
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -247,14 +247,19 @@ files:
 - lib/allscripts_api.rb
 - lib/allscripts_api/client.rb
 - lib/allscripts_api/configuration.rb
+- lib/allscripts_api/demographics.rb
+- lib/allscripts_api/demographics/demographics_methods.rb
 - lib/allscripts_api/documents.rb
 - lib/allscripts_api/documents/document.rb
 - lib/allscripts_api/documents/document_methods.rb
 - lib/allscripts_api/documents/document_sender.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/orders.rb
+- lib/allscripts_api/orders/order.rb
+- lib/allscripts_api/orders/ordering_methods.rb
+- lib/allscripts_api/patients.rb
+- lib/allscripts_api/patients/patient_methods.rb
 - lib/allscripts_api/utilities/validator.rb
 - lib/allscripts_api/version.rb
 homepage: https://github.com/Avhana/allscripts_api

data/lib/allscripts_api/order.rb

@@ -1,53 +0,0 @@
-# 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}
-  # @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Builder
-  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

@@ -1,42 +0,0 @@
-# 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