commit 3154052e0a39a4254d42ad32df61dc30b901ed60 Author: gered Date: Fri Jul 4 09:04:45 2014 -0400 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e91d482 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +.DS_Store +/target +/classes +/checkouts +pom.xml +pom.xml.asc +*.jar +*.class +/.lein-* +/.nrepl-port +.settings/ +.project +.classpath +.idea/ +*.iml +*.ipr +*.iws \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2bb9ad2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb4dea8 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# clj-hl7-fhir + +[HL7 FHIR](http://hl7.org/implement/standards/fhir/) JSON client. + +## Usage + +FIXME + +## License + +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. diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..23b3a14 --- /dev/null +++ b/project.clj @@ -0,0 +1,10 @@ +(defproject clj-hl7-fhir "0.1.0-SNAPSHOT" + :description "HL7 FHIR JSON client" + :url "https://github.com/gered/clj-hapi-fhir" + :license {:name "Apache License, Version 2.0" + :url "http://www.apache.org/licenses/LICENSE-2.0"} + :dependencies [[org.clojure/clojure "1.6.0"] + [cheshire "5.3.1"] + [clj-http "0.9.2"] + [com.cemerick/url "0.1.1"] + [camel-snake-kebab "0.1.5"]]) diff --git a/src/clj_hl7_fhir/core.clj b/src/clj_hl7_fhir/core.clj new file mode 100644 index 0000000..1efdf34 --- /dev/null +++ b/src/clj_hl7_fhir/core.clj @@ -0,0 +1,83 @@ +(ns clj-hl7-fhir.core + (:import (java.util Date)) + (:require [clojure.string :as str] + [clj-http.client :as http] + [cheshire.core :as json]) + (:use [camel-snake-kebab] + [clj-hl7-fhir.util])) + +(defn- ->fhir-resource-name [x] + (name (->CamelCase x))) + +(defn- fhir-get-request [base-url resource-url & [params]] + (let [query (cond + (seq? params) (->> params (concat [:_format "json"]) (kv-vector->query)) + :else (merge {:_format "json"} params))] + (-> (build-url base-url resource-url query) + (http/get) + :body + (json/parse-string true)))) + +(defn- format-search-value [x] + (cond + (instance? Date x) (->iso-date x) + :else x)) + +(defn- make-search-param-name [parameter & [modifier]] + (keyword + (str + (name parameter) + (if modifier + (str ":" (name modifier)))))) + +(defmacro single-search-op [name operator] + `(defn ~name [parameter# value# & {:keys [modifier#]}] + [(make-search-param-name parameter# modifier#) + (str (if-not (= "=" ~operator) ~operator) + (format-search-value value#))])) + +(defmacro double-search-op [name operator1 operator2] + `(defn ~name [parameter# value1# value2# & {:keys [modifier#]}] + [(make-search-param-name parameter# modifier#) + (str (if-not (= "=" ~operator1) ~operator1) + (format-search-value value1#)) + (make-search-param-name parameter# modifier#) + (str (if-not (= "=" ~operator2) ~operator2) + (format-search-value value2#))])) + +(single-search-op eq "=") +(single-search-op lt "<") +(single-search-op lte "<=") +(single-search-op gt ">") +(single-search-op gte ">=") +(double-search-op between ">" "<") + +(defn get-resource + "gets a single resource from a FHIR server. can optionally get a specific version of a resource. + + reference: + read: http://hl7.org/implement/standards/fhir/http.html#read + vread: http://hl7.org/implement/standards/fhir/http.html#vread" + [base-url type id & {:keys [version]}] + (let [resource-name (->fhir-resource-name type) + url-components (if version + ["/" resource-name id "_history" version] + ["/" resource-name id])] + (fhir-get-request + base-url + (apply join-paths url-components)))) + +(defn search + "searches for resources on a FHIR server. multiple parameters are ANDed together. use of the search + operator helper functions is encouraged to ensure proper escaping/encoding of search parameters. + + reference: + search: http://hl7.org/implement/standards/fhir/http.html#search" + [base-url type & params] + (let [resource-name (->fhir-resource-name type) + url-components ["/" resource-name]] + (fhir-get-request + base-url + (apply join-paths url-components) + (apply concat params)))) + diff --git a/src/clj_hl7_fhir/util.clj b/src/clj_hl7_fhir/util.clj new file mode 100644 index 0000000..1c320fc --- /dev/null +++ b/src/clj_hl7_fhir/util.clj @@ -0,0 +1,43 @@ +(ns clj-hl7-fhir.util + (:import (java.util TimeZone Date) + (java.text SimpleDateFormat)) + (:require [clojure.string :as str] + [cemerick.url :refer [url url-encode]])) + +(def tz (TimeZone/getDefault)) +(def iso8601 "yyyy-MM-dd'T'HH:mm:ssZZ") + +(defn ->iso-date + "returns an ISO8601 formatted date/time string for the given date. this is the format + which FHIR expects all date/times to be in" + [^Date date] + (if date + (let [df (SimpleDateFormat. iso8601)] + (.setTimeZone df tz) + (.format df date)))) + +(defn kv-vector->query + "should really be using cemerick.url/map->query in all cases except when you need 2 values under the + name name in the query string (such as with FHIR's date 'between' search support)" + [kvs] + (some->> (partition 2 kvs) + (map (fn [[k v]] + [(url-encode (name k)) + "=" + (url-encode (str v))])) + (interpose "&") + flatten + (apply str))) + +(defn join-paths [& paths] + (as-> paths x + (remove nil? x) + (str/join "/" x) + (str/replace x #"(/+)" "/"))) + +(defn build-url [base-url path & [params]] + (-> (url base-url) + (update-in [:path] (fn [existing-path] + (join-paths existing-path path))) + (assoc :query params) + (str))) diff --git a/test/clj_hl7_fhir/core_test.clj b/test/clj_hl7_fhir/core_test.clj new file mode 100644 index 0000000..2156af8 --- /dev/null +++ b/test/clj_hl7_fhir/core_test.clj @@ -0,0 +1,7 @@ +(ns clj-hl7-fhir.core-test + (:require [clojure.test :refer :all] + [clj-hl7-fhir.core :refer :all])) + +(deftest a-test + (testing "FIXME, I fail." + (is (= 0 1))))