Enum FhirVersion 

pub enum FhirVersion {
    R4,
}

Enumeration of supported FHIR specification versions.

This enum represents the different versions of the FHIR (Fast Healthcare Interoperability Resources) specification that this library supports. Each version represents a specific release of the FHIR standard with its own set of features, resources, and compatibility requirements.

Version Status

• R4 (4.0.1): Normative version, widely adopted in production
• R4B (4.3.0): Ballot version with additional features
• R5 (5.0.0): Ballot version with significant enhancements
• R6 (6.0.0): Draft version under active development

Feature Flags

Each version is controlled by a corresponding Cargo feature flag:

• R4: Enables FHIR R4 support
• R4B: Enables FHIR R4B support
• R5: Enables FHIR R5 support
• R6: Enables FHIR R6 support

Examples

use helios_fhir::FhirVersion;

// Version comparison
assert_ne!(FhirVersion::R4, FhirVersion::R5);

// String representation
let version = FhirVersion::R4;
assert_eq!(version.as_str(), "R4");
assert_eq!(version.to_string(), "R4");

CLI Integration

This enum implements clap::ValueEnum for command-line argument parsing:

use clap::Parser;
use helios_fhir::FhirVersion;

#[derive(Parser)]
struct Args {
    #[arg(value_enum)]
    version: FhirVersion,
}

Variants

R4

FHIR 4.0.1 (normative) - The current normative version

Implementations

impl FhirVersion

pub fn as_str(&self) -> &'static str

Returns the string representation of the FHIR version.

This method provides the standard version identifier as used in FHIR documentation, URLs, and configuration files.

Returns

A static string slice representing the version (e.g., “R4”, “R5”).

Examples

use helios_fhir::FhirVersion;

assert_eq!(FhirVersion::R4.as_str(), "R4");
assert_eq!(FhirVersion::R5.as_str(), "R5");

Usage

This method is commonly used for:

• Logging and debugging output
• Configuration file parsing
• API endpoint construction
• Version-specific resource loading

Trait Implementations

impl Clone for FhirVersion

fn clone(&self) -> FhirVersion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FhirVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for FhirVersion

Provides a default FHIR version when R4 feature is enabled.

R4 is chosen as the default because it is the current normative version of the FHIR specification and is widely adopted in production systems.

Examples

use helios_fhir::FhirVersion;

let default_version = FhirVersion::default();
assert_eq!(default_version, FhirVersion::R4);

fn default() -> FhirVersion

Returns the “default value” for a type.

impl Display for FhirVersion

Implements Display trait for user-friendly output formatting.

This enables FhirVersion to be used in string formatting operations and provides consistent output across different contexts.

Examples

use helios_fhir::FhirVersion;

let version = FhirVersion::R5;
println!("Using FHIR version: {}", version); // Prints: "Using FHIR version: R5"

let formatted = format!("fhir-{}.json", version);
assert_eq!(formatted, "fhir-R5.json");

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for FhirVersion

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FhirVersion

fn eq(&self, other: &FhirVersion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValueEnum for FhirVersion

Implements clap::ValueEnum for command-line argument parsing.

This implementation enables FhirVersion to be used directly as a command-line argument type with clap, providing automatic parsing, validation, and help text generation.

Examples

use clap::Parser;
use helios_fhir::FhirVersion;

#[derive(Parser)]
struct Args {
    /// FHIR specification version to use
    #[arg(value_enum, default_value_t = FhirVersion::default())]
    version: FhirVersion,
}

// Command line: my-app --version R5
let args = Args::parse();
println!("Using FHIR version: {}", args.version);

Generated Help Text

When using this enum with clap, the help text will automatically include all available FHIR versions based on enabled feature flags.

fn value_variants<'a>() -> &'a [FhirVersion]

All possible argument values, in display order.

fn to_possible_value(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for FhirVersion

impl Eq for FhirVersion

impl StructuralPartialEq for FhirVersion