fhir_client 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 00a173dc4e9ddb7b710daea38e2f89d3790db646
4
+ data.tar.gz: 6b5d0bc26cb16a2771b7ed760fa5be7ce8449868
5
+ SHA512:
6
+ metadata.gz: 6dd8dbf2f5265f2755d7aacf63d052c0d525df7dfee39f9251f908d8de929af40d9d57aaef73233c2ffc4dc3b3ab23048c5af1abcbcfac24b574e27c459ff17b
7
+ data.tar.gz: f915a5d4f7b7bed90935c80f2015533de1b0ff6e943f8935502039b2fb82b906ebc2e9ae763d0913a82971a913a32da35788e657839cef3659cbaf6e2395c071
data/.gitignore ADDED
@@ -0,0 +1,38 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /test/tmp/
9
+ /test/version_tmp/
10
+ /tmp/
11
+
12
+ ## Specific to RubyMotion:
13
+ .dat*
14
+ .repl_history
15
+ build/
16
+
17
+ ## Documentation cache and generated files:
18
+ /.yardoc/
19
+ /_yardoc/
20
+ /doc/
21
+ /rdoc/
22
+
23
+ ## Environment normalisation:
24
+ /.bundle/
25
+ /lib/bundler/man/
26
+
27
+ # for a library or gem, you might want to ignore these files since the code is
28
+ # intended to run in multiple environments; otherwise, check them in:
29
+ # Gemfile.lock
30
+ # .ruby-version
31
+ # .ruby-gemset
32
+
33
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
34
+ .rvmrc
35
+
36
+ # Logs
37
+ *.log
38
+ *.log.*
data/.travis.yml ADDED
@@ -0,0 +1,10 @@
1
+ language: ruby
2
+ rvm:
3
+ - "2.0.0"
4
+ services: mongodb
5
+ script: bundle exec rake test
6
+ notifications:
7
+ email:
8
+ recipients:
9
+ - healthcare-ci@googlegroups.com
10
+ on_failure: change
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source "http://rubygems.org"
2
+ gemspec
3
+
4
+ group :test do
5
+ gem 'simplecov', :require => false
6
+ gem 'minitest', "~> 4.0"
7
+ gem 'turn', :require => false
8
+ gem 'awesome_print', :require => 'ap'
9
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,98 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ fhir_client (1.0.0)
5
+ activesupport (>= 3)
6
+ addressable (>= 2.3)
7
+ fhir_models (~> 0.3)
8
+ oauth2 (~> 1.1)
9
+ rest-client (~> 1.8)
10
+ tilt (>= 1.1)
11
+
12
+ GEM
13
+ remote: http://rubygems.org/
14
+ specs:
15
+ activesupport (4.0.13)
16
+ i18n (~> 0.6, >= 0.6.9)
17
+ minitest (~> 4.2)
18
+ multi_json (~> 1.3)
19
+ thread_safe (~> 0.1)
20
+ tzinfo (~> 0.3.37)
21
+ addressable (2.4.0)
22
+ ansi (1.5.0)
23
+ awesome_print (1.6.1)
24
+ bcp47 (0.3.3)
25
+ i18n
26
+ coderay (1.1.1)
27
+ date_time_precision (0.8.1)
28
+ docile (1.1.5)
29
+ domain_name (0.5.20160310)
30
+ unf (>= 0.0.5, < 1.0.0)
31
+ faraday (0.9.2)
32
+ multipart-post (>= 1.2, < 3)
33
+ fhir_models (0.3.0)
34
+ bcp47 (>= 0.3)
35
+ date_time_precision (>= 0.8)
36
+ mime-types (>= 1.16, < 3)
37
+ nokogiri (>= 1.6)
38
+ rake (>= 0.8.7)
39
+ http-cookie (1.0.2)
40
+ domain_name (~> 0.5)
41
+ i18n (0.7.0)
42
+ json (1.8.2)
43
+ jwt (1.5.1)
44
+ method_source (0.8.2)
45
+ mime-types (2.99.2)
46
+ mini_portile2 (2.0.0)
47
+ minitest (4.7.5)
48
+ multi_json (1.12.1)
49
+ multi_xml (0.5.5)
50
+ multipart-post (2.0.0)
51
+ netrc (0.11.0)
52
+ nokogiri (1.6.7.2)
53
+ mini_portile2 (~> 2.0.0.rc2)
54
+ oauth2 (1.1.0)
55
+ faraday (>= 0.8, < 0.10)
56
+ jwt (~> 1.0, < 1.5.2)
57
+ multi_json (~> 1.3)
58
+ multi_xml (~> 0.5)
59
+ rack (>= 1.2, < 3)
60
+ pry (0.10.3)
61
+ coderay (~> 1.1.0)
62
+ method_source (~> 0.8.1)
63
+ slop (~> 3.4)
64
+ rack (1.6.4)
65
+ rake (11.1.2)
66
+ rest-client (1.8.0)
67
+ http-cookie (>= 1.0.2, < 2.0)
68
+ mime-types (>= 1.16, < 3.0)
69
+ netrc (~> 0.7)
70
+ simplecov (0.10.0)
71
+ docile (~> 1.1.0)
72
+ json (~> 1.8)
73
+ simplecov-html (~> 0.10.0)
74
+ simplecov-html (0.10.0)
75
+ slop (3.6.0)
76
+ thread_safe (0.3.5)
77
+ tilt (2.0.4)
78
+ turn (0.9.7)
79
+ ansi
80
+ minitest (~> 4)
81
+ tzinfo (0.3.49)
82
+ unf (0.1.4)
83
+ unf_ext
84
+ unf_ext (0.0.7.2)
85
+
86
+ PLATFORMS
87
+ ruby
88
+
89
+ DEPENDENCIES
90
+ awesome_print
91
+ fhir_client!
92
+ minitest (~> 4.0)
93
+ pry
94
+ simplecov
95
+ turn
96
+
97
+ BUNDLED WITH
98
+ 1.11.2
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,135 @@
1
+ # FHIR Client [![Build Status](https://travis-ci.org/fhir-crucible/fhir_client.svg?branch=master)](https://travis-ci.org/fhir-crucible/fhir_client)
2
+
3
+ Ruby FHIR client.
4
+
5
+ Supports:
6
+ * FHIR STU3
7
+ * XML and JSON
8
+ * All CRUD, including version read and history
9
+ * Transactions and Batches
10
+ * Search
11
+ * Operations (e.g. `$everything`, `$validate`)
12
+ * Support for OAuth2
13
+
14
+ ### Getting Started
15
+
16
+ $ bundle install
17
+ $ bundle exec rake fhir:console
18
+
19
+ ### Creating a Client
20
+ ```ruby
21
+ client = FHIR::Client.new(url)
22
+ ```
23
+
24
+ ### Searching
25
+ ```ruby
26
+ reply = client.search(FHIR::Patient, search: {parameters: {name: 'P'}})
27
+ bundle = reply.resource
28
+ patient = bundle.entry.first.resource
29
+ ```
30
+
31
+ ### Fetching a Bundle
32
+ ```ruby
33
+ reply = client.read_feed(FHIR::Patient) # fetch Bundle of Patients
34
+ bundle = reply.resource
35
+ bundle.entry.each do |entry|
36
+ patient = entry.resource
37
+ puts patient.name[0].text
38
+ end
39
+ puts reply.code # HTTP 200 (or whatever was returned)
40
+ puts reply.body # Raw XML or JSON
41
+ ```
42
+
43
+ ### CRUD Examples
44
+ ```ruby
45
+ # read an existing patient with id "example"
46
+ patient = client.read(FHIR::Patient, "example").resource
47
+
48
+ # read specifying Formats
49
+ patient = client.read(FHIR::Patient, "example", FHIR::Formats::FeedFormat::FEED_JSON).resource
50
+
51
+ # create a patient
52
+ patient = FHIR::Patient.new
53
+ patient_id = client.create(patient).id
54
+
55
+ # update the patient
56
+ patient.gender = 'female'
57
+ client.update(patient, patient_id)
58
+
59
+ # conditional update
60
+ p_identifier = FHIR::Identifier.new
61
+ p_identifier.use = 'official'
62
+ p_identifier.system = 'http://projectcrucible.org'
63
+ p_identifier.value = '123'
64
+ patient.identifier = [ p_identifier ]
65
+ searchParams = { :identifier => 'http://projectcrucible.org|123' }
66
+ client.conditional_update(patient, patient_id, searchParams)
67
+
68
+ # conditional create
69
+ ifNoneExist = { :identifier => 'http://projectcrucible.org|123' }
70
+ client.conditional_create(patient, ifNoneExist)
71
+
72
+ # destroy the patient
73
+ client.destroy(FHIR::Patient, patient_id)
74
+ ```
75
+
76
+ ### Transactions
77
+ ```ruby
78
+ # Create a patient
79
+ @patient = FHIR::Patient.new
80
+ @patient.id = 'temporary_id'
81
+
82
+ # Create an observation
83
+ @observation = FHIR::Observation.new
84
+ @observation.status = 'final'
85
+ @coding = FHIR::Coding.new
86
+ @coding.system = 'http://loinc.org'
87
+ @coding.code='8302-2'
88
+ @observation.code = FHIR::CodeableConcept.new
89
+ @observation.code.coding = [ @coding ]
90
+ @quantity = FHIR::Quantity.new
91
+ @quantity.value = 170
92
+ @quantity.unit = 'cm'
93
+ @quantity.system = 'http://unitsofmeasure.org'
94
+ @observation.valueQuantity = @quantity
95
+ @reference = FHIR::Reference.new
96
+ @reference.reference = "Patient/#{@patient.id}"
97
+ @observation.subject = @reference
98
+
99
+ # Submit them both as a transaction
100
+ @client.begin_transaction
101
+ @client.add_transaction_request('POST',nil,@patient)
102
+ @client.add_transaction_request('POST',nil,@observation)
103
+ reply = @client.end_transaction
104
+ ```
105
+
106
+ ### OAuth2 Support
107
+ ```ruby
108
+ client = FHIR::Client.new(url)
109
+ client_id = 'example'
110
+ client_secret = 'secret'
111
+ options = client.get_oauth2_metadata_from_conformance
112
+ if options.empty?
113
+ puts 'This server does not support the expected OAuth2 extensions.'
114
+ else
115
+ client.set_oauth2_auth(client_id,client_secret,options[:site],options[:authorize_url],options[:token_url])
116
+ reply = client.read_feed(FHIR::Patient)
117
+ puts reply.body
118
+ end
119
+ ```
120
+
121
+ # License
122
+
123
+ Copyright 2014-2016 The MITRE Corporation
124
+
125
+ Licensed under the Apache License, Version 2.0 (the "License");
126
+ you may not use this file except in compliance with the License.
127
+ You may obtain a copy of the License at
128
+
129
+ http://www.apache.org/licenses/LICENSE-2.0
130
+
131
+ Unless required by applicable law or agreed to in writing, software
132
+ distributed under the License is distributed on an "AS IS" BASIS,
133
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
134
+ See the License for the specific language governing permissions and
135
+ limitations under the License.