FHIR SDK

This is a FHIR library in its early stages. The models are generated from the FHIR StructureDefinitions (see FHIR downloads). It aims to be:

• fully compliant
• as safe as possibe
• as easy to use as possible
• fully featured

Features

• Generated FHIR codes, types and resources
• Serialization and deserialization to and from JSON
• Optional builders for types and resources
• Implementation of base traits
  • (Base)Resource for accessing common fields
  • NamedResource for getting the resource type in const time
  • DomainResource for accessing common fields
  • IdentifiableResource for all resources with an identifier field
• Client implementation
  • Create, Read, Update, Delete
  • Search + Paging
  • Batch operations / Transactions
  • Authentication callback
  • Operations
  • Patch
  • GraphQL
• FHIRpath implementation
• Resource validation using FHIRpath and regular expressions

Not Planned

• XML

Example

use fhir_sdk::r5::resources::Patient;
use fhir_sdk::client::*;
use fhir_sdk::TryStreamExt;

#[tokio::main]
async fn main() -> Result<(), Error> {
    // Set up the client using the local test server.
    let settings = RequestSettings::default()
        .header(header::AUTHORIZATION, "Bearer <token>".parse().unwrap());
    let client = Client::builder()
        .base_url("http://localhost:8090/fhir/".parse().unwrap())
        .request_settings(settings)
        .build()?;

    // Create a Patient resource using a typed builder.
    let mut patient = Patient::builder().active(false).build();
    // Push it to the server.
    patient.create(&client).await?;
    // The id and versionId is updated automatically this way.
    assert!(patient.id.is_some());
    
    // Search for all patient with `active` = false, including pagination.
    let patients: Vec<Patient> = client
        .search(SearchParameters::empty().and(TokenSearch::Standard {
            name: "active",
            system: None,
            code: Some("false"),
            not: false,
        }))
        .try_collect()
        .await?;

    Ok(())
}

For more examples, see the tests.

Testing

Simply set up the FHIR test environment using cargo xtask docker -- up -d and then run cargo xtask test. If you need sudo to run docker, use the --sudo or just -s flag on cargo xtask docker.

Known Problems

• Due to the big number of big types, the compile time and its memory usage is really high. This is due to serde and typed builder derives being highly generic. The builders can be disabled by disabling the builders feature to save some resources.
• The builders cannot use setter(strip_option), because it disables dynamic setting of optional fields.
• Vec<Option<T>> is annoying, but sadly is required to allow [null, {...}, null] for using FHIR resources with extensions..

More examples

Authentication callback

use fhir_sdk::r5::resources::Patient;
use fhir_sdk::client::*;

async fn my_auth_callback() -> Result<HeaderValue, eyre::Report> {
    Ok(HeaderValue::from_static("Bearer <token>"))
}

#[tokio::main]
async fn main() -> Result<(), Error> {
    // Set up the client using the local test server.
    let client = Client::builder()
        .base_url("http://localhost:8090/fhir/".parse().unwrap())
        .auth_callback(my_auth_callback)
        .build()?;

    // Create a Patient resource using a typed builder.
    let mut patient = Patient::builder().active(false).build();
    // Push it to the server. On unauthorized failures, the client will call our
    // auth_callback method to refresh the authorization.
    patient.create(&client).await?;

    Ok(())
}

Resource identifier access

use fhir_sdk::r5::{
    codes::AdministrativeGender,
    resources::{IdentifiableResource, Patient},
    types::{Identifier, HumanName},
};

#[tokio::main]
async fn main() {
    // Create a Patient resource using a typed builder.
    let mut patient = Patient::builder()
        .active(false)
        .identifier(vec![Some(Identifier::builder().system("MySystem".to_owned()).value("ID".to_owned()).build())])
        .gender(AdministrativeGender::Male)
        .name(vec![Some(HumanName::builder().family("Test".to_owned()).build())])
        .build();

    // Check the identifier value.
    assert_eq!(patient.identifier_with_system("MySystem").map(String::as_str), Some("ID"));
}

Lints

This projects uses a bunch of clippy lints for higher code quality and style.

Install cargo-lints using cargo install --git https://github.com/FlixCoder/cargo-lints. The lints are defined in lints.toml and can be checked by running cargo lints clippy --all-targets --workspace.

License

Licensed under the MIT license. All contributors agree to license under this license.