bloom_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79978a9d395de7d6641f7d7e7c701303fe64a2f8
+  data.tar.gz: 471a65706596e3e316327446a825558383cac87d
+SHA512:
+  metadata.gz: 68cd0f7cfae9037ffe1bae9b85d14f944c49966883ba8531ba0a6fb90b21f93ceeaa888cbd5c6d944c97434c6b9fee51d6df257ab94edb953d098c36b9b4b78b
+  data.tar.gz: 82ef03b48b114787326117066163cea9c0a243859aac751e45cd495913e6ae4ed266aaea4a9f5a46360bfe37c1d0f2550a2a4bce5c2591208d3a09d6b157d6b0

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bloom_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    bloom_api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bloom_api!
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Carpenter
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# BloomApi
+
+This gem provides a client for accessing healthcare provider information
+via Bloom Api. For detailed information on Bloom Api visit the
+web site (http://www.bloomapi.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bloom_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bloom_api
+
+## Usage
+
+### Look up a provider
+    provider = BloomApi.find_by_npi('1841223922')
+    provider.npi                      # => '1841223922'
+    provider.first_name               # => 'PETER'
+    provider.business_address.state   # => 'OH'
+    
+For a list of all data available visit the Bloom Api site above and / or
+check out the ruby docs here: http://www.rubydoc.info/github/carp47/bloom_api/master
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bloom_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bloom_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bloom_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bloom_api"
+  spec.version       = BloomApi::VERSION
+  spec.authors       = ["Daniel Carpenter"]
+  spec.email         = ["daniel.carpenter01@gmail.com"]
+  spec.summary       = %q{A gem for retrieving data from the Bloom API.}
+  spec.description   = %q{A ruby gem for accessing data from any instance of the Bloom API. For more informatoin, visit http://www.bloomapi.com/}
+  spec.homepage      = "https://github.com/carp47/bloom_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/bloom_api/address.rb

@@ -0,0 +1,56 @@
+module BloomApi
+  # An address object containing the availabile
+  # data of business or practice addresses in Bloom API
+  class Address
+
+    # Creats a new BloomApi::Address
+    #
+    # @param [Hash]
+    #   A hash representation of a JSON address as it would be
+    #   returned from the Bloom API
+    def initialize raw_address
+      @raw_address = raw_address
+    end
+
+    # @return [String] The address's city
+    def city
+      @raw_address['city']
+    end
+
+    # @return [String] The address's country code
+    def country
+      @raw_address['country_code']
+    end
+
+    # @return [String] The fax number for the address
+    def fax
+      @raw_address['fax']
+    end
+
+    # @return [String] Line 1 of the address
+    def line1
+      @raw_address['address_line']
+    end
+
+    # @return [String] Line 2 of the address
+    def line2
+      @raw_address['address_details_line']
+    end
+
+    # @return [String] The contact phone number for the address
+    def phone
+      @raw_address['phone']
+    end
+
+    # @return [String] The 2-digit state code for the address
+    def state
+      @raw_address['state']
+    end
+
+    # @return [String] The zip code for the address
+    def zip
+      @raw_address['zip']
+    end
+
+  end
+end

data/lib/bloom_api/identifier.rb

@@ -0,0 +1,41 @@
+module BloomApi
+  # An alternate unique identifier for a provider
+  class Identifier
+
+    # Creates a new Identifier
+    # @param raw_identifier [Hash]
+    def initialize raw_identifier
+      @raw_identifier = raw_identifier
+    end
+
+    # @return [String] the unique identifier
+    def identifier
+      @raw_identifier['identifier']
+    end
+
+    # @return [String] The issuing party for the identifier
+    def issuer
+      @raw_identifier['issuer']
+    end
+
+    # @return [String] The U.S. state in which the identifier applies
+    def state
+      @raw_identifier['state']
+    end
+
+    # @return [String]
+    #   The type of identifier.
+    #   Possible values are:
+    #   * other
+    #   * medicare upin
+    #   * medicare id-type unspecified
+    #   * medicaid
+    #   * medicare oscar/certification
+    #   * medicare nsc
+    #   * medicare pin
+    def type
+      @raw_identifier['type']
+    end
+
+  end
+end

data/lib/bloom_api/individual.rb

@@ -0,0 +1,82 @@
+module BloomApi
+  # A class representing an individual provider
+  class Individual < Provider
+
+    # @return [String] the provider's professional credential
+    def credential
+      @raw_provider['credential']
+    end
+
+    # @return [String] the provider's first name
+    def first_name
+      @raw_provider['first_name']
+    end
+
+    # @return [String] the provider's gender
+    def gender
+      @raw_provider['gender']
+    end
+
+    # @return [String] the provider's last name
+    def last_name
+      @raw_provider['last_name']
+    end
+
+    # @return [String] the provider's middle name
+    def middle_name
+      @raw_provider['middle_name']
+    end
+
+    # @return [String] the providers name prefix (Mr., Ms., etc.)
+    def name_prefix
+      @raw_provider['name_prefix']
+    end
+
+    # @return [String] the provider's name suffix (Jr., Sr., Etc.)
+    def name_suffix
+      @raw_provider['name_suffix']
+    end
+
+    # @return [String] an additional professional credential
+    def other_credential
+      @raw_provider['other_credential']
+    end
+
+    # @return [String] an alternate first name for the provider
+    def other_first_name
+      @raw_provider['other_first_name']
+    end
+
+    # @return [String] an alternate last name for the provider
+    def other_last_name
+      @raw_provider['other_last_name']
+    end
+
+    # @return [String]
+    #   a code describing the purpose of the provider's alternate
+    #   last name. Possible values are:
+    #   * former name
+    #   * professional name
+    #   * doing business as
+    #   * former legal business name
+    #   * other name
+    def other_last_name_type_code
+      @raw_provider['provider_other_last_name_type_code']
+    end
+
+    # @return [String] the provider's alternate last name
+    def other_middle_name
+      @raw_provider['other_middle_name']
+    end
+
+    # @return [String] the provider's alternate name prefix
+    def other_name_prefix
+      @raw_provider['other_name_prefix']
+    end
+
+    # @return [String] the provider's altername name suffix
+    def other_name_suffix
+      @raw_provider['other_name_suffix']
+    end
+  end
+end

data/lib/bloom_api/organization.rb

@@ -0,0 +1,61 @@
+module BloomApi
+
+  #A class representing an organizational provider
+  class Organization < Provider
+
+    # @return [String] the organization's employer identification number
+    def employer_identification_number
+      case @raw_provider['employer_identification_number']
+      when '<UNAVAIL>'
+        nil
+      else
+        @raw_provider['employer_identification_number']
+      end
+    end
+
+    # designates whether the organization is a part of another
+    # @return [boolean] true if part of another organization
+    # @return [boolean] false if not part of another organization
+    def is_subpart?
+      case @raw_provider['organization_subpart']
+      when 'yes'
+        true
+      when 'no'
+        false
+      else
+        nil
+      end
+    end
+
+    # @return [String] the business name of the organization
+    def name
+      @raw_provider['business_name']
+    end
+
+    # @return [OrganizationOfficial] the organization's administrative official
+    def official
+      unless @raw_provider['organization_official'].nil?
+        OrganizationOfficial.new(@raw_provider['organization_official'])
+      end
+    end
+
+    # @return [String] an alternate name for the organization
+    def other_name
+      @raw_provider['other_name']
+    end
+
+    # @return [Organization] if the provider has a parent organization
+    # @return nil if there is no parent organization
+    def parent_organization
+      unless @raw_provider['parent_org'].nil?
+        Organization.new(@raw_provider['parent_org'])
+      end
+    end
+
+    # @return [String] the organization's tax identification number
+    def tax_identification_number
+      @raw_provider['tax_identification_number']
+    end
+
+  end
+end

data/lib/bloom_api/organization_official.rb

@@ -0,0 +1,54 @@
+module BloomApi
+  # A class representing an organization official
+  class OrganizationOfficial
+
+    # Creates a new OrganizationOfficial
+    # @param raw_official [Hash]
+    #   A hash representation of the organization_official object
+    #   available in the BloomApi
+    def initialize(raw_official)
+      @raw_official = raw_official
+    end
+
+    # @return [String] the official's professional credential
+    def credential
+      @raw_official['credential']
+    end
+
+    # @return [String] the official's first name
+    def first_name
+      @raw_official['first_name']
+    end
+
+    # @return [String] the official's last name
+    def last_name
+      @raw_official['last_name']
+    end
+
+    # @return [String] the official's middle name
+    def middle_name
+      @raw_official['middle_name']
+    end
+
+    # @return [String] the official's name prefix
+    def name_prefix
+      @raw_official['name_prefix']
+    end
+
+    # @return [String] the official's name suffix
+    def name_suffix
+      @raw_official['name_suffix']
+    end
+
+    # @return [String] the official's phone number
+    def phone
+      @raw_official['phone']
+    end
+
+    # @return [String] the official's professional title
+    def title
+      @raw_official['title']
+    end
+
+  end
+end

data/lib/bloom_api/provider.rb

@@ -0,0 +1,118 @@
+module BloomApi
+
+  # A class representing a generic provider. This is a base
+  # class for individuals and organizations.
+  class Provider
+
+    # Create a new provider
+    # @param [Hash]
+    #   a hash representation of a json provider
+    #   object from the bloom API
+    def initialize(raw_provider)
+      @raw_provider = raw_provider
+    end
+
+    # @return [BloomApi::Address] the provider's business address
+    def business_address
+      Address.new(@raw_provider['business_address'])
+    end
+
+    # @return [Date]
+    #   if the provider has been deactivated returns the date of deactivation
+    # @return [nil] if the the provider has not been deactivated
+    def deactivation_date
+      unless @raw_provider['deactivation_date'].nil?
+        Time.parse(@raw_provider['deactivation_date']).to_date
+      end
+    end
+
+    # @return [String] the reason the provider was deactivated
+    def deactivation_reason
+      @raw_provider['deactivation_reason']
+    end
+
+    # @return [String] the provider's national provider identifier
+    def npi
+      @raw_provider['npi']
+    end
+
+    # @return [BloomApi::Address] the provider's practice address
+    def practice_address
+      Address.new(@raw_provider['practice_address'])
+    end
+
+    # @return [Array] A list of alternate identifiers for the provider
+    def other_identifiers
+      unless @raw_provider['other_identifiers'].nil?
+        @raw_provider['other_identifiers'].collect { |i| BloomApi::Identifier.new(i) }
+      end
+    end
+
+    # @return [String]
+    #   a type describing the purpose of the provider's alternate name
+    def other_name_type
+      @raw_provider['other_name_type']
+    end
+
+    # @return [Date]
+    #   the reactivation date for the provider if it's been reactivated
+    # @return [nil] if the provider has not been reactivated
+    def reactivation_date
+      unless @raw_provider['reactivation_date'].nil?
+        Time.parse(@raw_provider['reactivation_date']).to_date
+      end
+    end
+
+    # @return [Date]
+    #   the date that the provider information was recorded
+    def recorded_at
+      Time.parse(@raw_provider['enumeration_date']).to_date
+    end
+
+    # @return [String]
+    #   the provider's replacement npi
+    def replacement_npi
+      @raw_provider['replacement_npi']
+    end
+
+    # @return [boolean] true if the provider is a sole proprietor
+    # @return [boolean] false if the provider is not a sole proprietor
+    def sole_proprietor?
+      case @raw_provider['sole_proprietor']
+      when 'yes'
+        true
+      when 'no'
+        false
+      else
+        nil
+      end
+    end
+
+    # @return [Array] an array of specialties held by the provider
+    def specialties
+      unless @raw_provider['provider_details'].nil?
+        @raw_provider['provider_details'].collect { |s| Specialty.new(s) }
+      end
+    end
+
+    # @return [Array] an array of taxonomy groups for the provider
+    def taxonomy_groups
+      unless @raw_provider['taxonomy_groups'].nil?
+        @raw_provider['taxonomy_groups'].collect { |g| g['taxonomy']}
+      end
+    end
+
+    # @return [String]
+    #   The provider type. Possible values are:
+    #   * individual
+    #   * organization
+    def type
+      @raw_provider['type']
+    end
+
+    # @return [Date] the date that the provider's data was last updated
+    def updated_at
+      Time.parse(@raw_provider['last_update_date']).to_date
+    end
+  end
+end

data/lib/bloom_api/specialty.rb

@@ -0,0 +1,43 @@
+module BloomApi
+  # An class representing a provider specialty
+  class Specialty
+
+    # Creates a new specialty
+    # @param raw_detail [Hash]
+    #   A hash representation of a json specialty object
+    #   from the Bloom Api
+    def initialize raw_detail
+      @raw_detail = raw_detail
+    end
+
+    # @return [String]
+    #   the license number associated with the specialty
+    def license_number
+      @raw_detail['license_number']
+    end
+
+    # @return [String]
+    #   the U.S. state in which the specialty applies
+    def license_number_state
+      @raw_detail['license_number_state']
+    end
+
+    # @return [boolean] true if this is the provider's primary specialty
+    # @return [boolean] false if this is not the provider's primary specialty
+    def primary_specialty?
+      case @raw_detail['taxonomy_switch']
+      when 'yes'
+        true
+      when 'no'
+        false
+      else
+        nil
+      end
+    end
+
+    # @return [String] the specialty's code
+    def specialty_code
+      @raw_detail['healthcare_taxonomy_code']
+    end
+  end
+end

data/lib/bloom_api/version.rb

@@ -0,0 +1,4 @@
+module BloomApi
+  # the gem's version
+  VERSION = "0.0.2"
+end

data/lib/bloom_api.rb

@@ -0,0 +1,46 @@
+require "bloom_api/version"
+
+# A module which contains all code necessary for
+# looking up health care providers via the Bloom API.
+#
+# For more details visit http://www.bloomapi.com/
+#
+# @author Dan Carpenter
+module BloomApi
+
+  require "bloom_api/provider"
+  require "bloom_api/address"
+  require "bloom_api/identifier"
+  require "bloom_api/individual"
+  require "bloom_api/organization"
+  require "bloom_api/organization_official"
+  require "bloom_api/specialty"
+
+  # A custom exception for when no provider is found when performing a lookup.
+  class ProviderNotFound < Exception; end
+
+  # The base url for the bloom api.
+  BASE_URL = "www.bloomapi.com"
+
+  # Look up a health care provider by their national provider identifier
+  #
+  # @params npi [String] The national provider identifier to be used for lookup
+  # @return [BloomApi::Individual] if the npi references an individual provider
+  # @return [BloomApi::Organization] if the npi references an organization
+  #
+  # @raise [ProviderNotFound] if the provided npi does not reference a provider
+  def self.find_by_npi(npi)
+    response = Net::HTTP.get_response(BASE_URL, "/api/npis/#{npi}")
+
+    build_provider(JSON.parse(response.body)['result']) if response.code == "200"
+  end
+
+  private
+
+  def self.build_provider(response)
+    return Individual.new(response) if response['type'] == 'individual'
+    return Organization.new(response) if response['type'] == 'organization'
+    Provider.new(response)
+  end
+
+end