Struct NppesDatasetBuilder 

pub struct NppesDatasetBuilder { /* private fields */ }

Builder for loading a complete NPPES dataset

Example

let dataset = NppesDatasetBuilder::new()
    .main_data("data/npidata_pfile_20240101-20240107.csv")
    .taxonomy_reference("data/nucc_taxonomy_240.csv")
    .other_names("data/othername_pfile_20240101-20240107.csv")
    .practice_locations("data/pl_pfile_20240101-20240107.csv")
    .endpoints("data/endpoint_pfile_20240101-20240107.csv")
    .build()?;

Example with URL

// NOTE: This URL points to a future data file format (May 2025).
// To download the latest available data, use `NppesDatasetBuilder::download_latest()`.
let dataset = NppesDatasetBuilder::new()
    .from_url("https://download.cms.gov/nppes/NPPES_Data_Dissemination_May_2025_V2.zip")
    .build_async().await?;

Implementations

impl NppesDatasetBuilder

pub fn new() -> Self

Create a new dataset builder

pub fn main_data<S: Into<DataSource>>(self, source: S) -> Self

Set the path or URL to the main NPPES data file

pub fn taxonomy_reference<S: Into<DataSource>>(self, source: S) -> Self

Set the path or URL to the taxonomy reference file

pub fn other_names<S: Into<DataSource>>(self, source: S) -> Self

Set the path or URL to the other names file

pub fn practice_locations<S: Into<DataSource>>(self, source: S) -> Self

Set the path or URL to the practice locations file

pub fn endpoints<S: Into<DataSource>>(self, source: S) -> Self

Set the path or URL to the endpoints file

pub fn from_url<S: Into<String>>(self, url: S) -> Self

Load data from a URL (ZIP file containing NPPES data)

pub fn with_download_config(self, config: DownloadConfig) -> Self

Set download configuration

pub fn skip_invalid_records(self, skip: bool) -> Self

Enable or disable skipping invalid records

pub fn build_indexes(self, build: bool) -> Self

Enable or disable automatic index building

pub fn show_progress(self, show: bool) -> Self

Enable or disable progress bars

pub fn build(self) -> Result<NppesDataset>

Build the dataset, loading all specified files (synchronous version)

pub async fn build_async(self) -> Result<NppesDataset>

Build the dataset from internet sources (async version)

pub fn from_directory<P: AsRef<Path>>(dir: P) -> Result<Self>

Load a standard dataset from a directory containing all NPPES files

Looks for files matching standard NPPES naming patterns in the given directory.

pub async fn download_latest() -> Result<NppesDataset>

Download the latest NPPES data and build dataset

Trait Implementations

impl Default for NppesDatasetBuilder

fn default() -> Self

Returns the “default value” for a type.