Getting Started

Project Dependency

If you are developing a ruby project that uses HL7 FHIR, getting started with fhir_client is easy using bundler.

If you do not have bundler installed, then first run:
$ gem install bundler

Create a new Gemfile or modify an existing project Gemfile and specify fhir_client as a project dependency:

source 'https://rubygems.org'
gem 'fhir_client'

Install the required dependencies using bundler

$ bundle install

Now create a simple ruby script script.rb to test the dependency:

# script.rb
require 'fhir_client'
puts FHIR::Client::VERSION

Run the script:

$ bundle exec ruby script.rb
4.0.4

If you see a version number printed out (e.g. in the above example 4.0.4), then the library is installed and ready to go.

Next, you might start your project by configuring fhir_client or just diving right into some CRUD operations.

If you are a developer who wants to modify and contribute to the fhir_client project, you can clone the repository and begin working.

$ git clone https://github.com/fhir-crucible/fhir_client.git
$ cd fhir_client

After the repository is cloned, install the dependencies using bundler:

$ bundle install

If you do not have bundler installed, then first run:
$ gem install bundler

Now, from the command line you can launch a ruby interpreter or begin editing the fhir_client source files.

$ bundle exec rake fhir:console
2.5.1 :001 > FHIR::Client::VERSION
 => "4.0.4" 
2.5.1 :002 >

Make sure you run the unit tests, and add or modify any unit tests to reflect any changes you make prior to submitting any pull requests:

$ bundle exec rake test