FHIR Client

Ruby FHIR client.

Supports:

• FHIR DSTU2
• XML and JSON
• All CRUD, including version read and history
• Search
• Operations (e.g. $everything, $validate)
• Support for OAuth2

Getting Started

$ bundle install
$ bundle exec rake fhir:console

Creating a Client

client = FHIR::Client.new(url)

Searching

reply = client.search(FHIR::Patient, search: {parameters: {name: 'P'}})
bundle = reply.resource

Fetching a Bundle

reply = client.read_feed(FHIR::Patient) # fetch Bundle of Patients
bundle = reply.resource
bundle.entry.each do |entry|
  patient = entry.resource
  puts patient.name[0].text
end
puts reply.code # HTTP 200 (or whatever was returned)
puts reply.body # Raw XML or JSON

CRUD Examples

# read an existing patient with id "example"
patient = client.read(FHIR::Patient, "example").resource
# specifying Formats
patient = client.read(FHIR::Patient, "example", FHIR::Formats::FeedFormat::FEED_JSON).resource

# update the patient
patient.gender = 'female'
client.update(patient, patient.xmlId)

# destroy the patient
client.destroy(FHIR::Patient, patient.xmlId)

OAuth2 Support

client = FHIR::Client.new(url)
client_id = 'example'
client_secret = 'secret'
options = client.get_oauth2_metadata_from_conformance
if options.empty?
  puts 'This server does not support the expected OAuth2 extensions.'
else
  client.set_oauth2_auth(client_id,client_secret,options[:site],options[:authorize_url],options[:token_url])
  reply = client.read_feed(FHIR::Patient)
  puts reply.body
end

License

Copyright 2014-2015 The MITRE Corporation

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.