Question 1

How do I set up OAuth2 authentication with the FHIR client in Ruby?

Accepted Answer

Use the client.get_oauth2_metadata_from_conformance method to fetch server details, then call client.set_oauth2_auth with client ID, secret, and URLs, as shown in the README OAuth2 example. This handles token management for secure requests.

Question 2

What's the difference between basic and advanced modes in FHIR client?

Accepted Answer

Basic mode uses an ActiveRecord-like interface for simple CRUD operations with models, while advanced mode provides low-level control over FHIR requests, necessary for transactions or custom headers but less intuitive. The README highlights this trade-off.

Question 3

FHIR client Ruby vs HAPI FHIR Java client – which should I use?

Accepted Answer

Choose FHIR client Ruby for Ruby-based projects needing comprehensive FHIR support with dual formats and versions. HAPI FHIR is better for Java ecosystems, offering a larger toolset but depends on your tech stack; this library is Ruby-specific.

Question 4

How to handle search with multiple parameters in FHIR client?

Accepted Answer

Use the client.search method with a hash of parameters, either via GET or POST, as demonstrated in the README. For example, client.search(FHIR::Patient, search: {parameters: {name: 'P'}}) retrieves patients matching the criteria.

Question 5

Does the FHIR client support conditional updates and creates?

Accepted Answer

Yes, it supports conditional operations like conditional_update and conditional_create using search parameters to prevent duplicates, as shown in the CRUD examples with identifiers and search conditions.

Question 6

How to switch between JSON and XML formats in the client?

Accepted Answer

Call client.default_json or client.default_xml to set the preferred format globally, as explained in the 'Changing FHIR Formats' section. This affects all subsequent requests unless overridden.

Question 7

Can I use this library with FHIR R5 or older versions like STU3?

Accepted Answer

Yes, it supports FHIR R5, R4B, R4, STU3, and DSTU2 with auto-detection or manual switching via methods like use_r4 or use_stu3, ensuring backward compatibility for legacy systems.

Ruby FHIR

What is Ruby FHIR?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions