List Hilfsmittel products

List Hilfsmittel products

Usage

hilfsmittel_produkte(
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

flatten

Logical; if TRUE, simplify nested list columns according to flatten_mode. Default FALSE keeps list columns as-is.

flatten_mode

How to handle list columns when flatten = TRUE:

"drop"

Remove list columns entirely. Use when nested data is not needed.

"json"

Convert each list element to a JSON string. Preserves all data in a text-queryable format. This is the default.

"unnest"

Expand list columns into multiple rows via tidyr::unnest_longer(). Warning: this can significantly increase the number of rows.

Value

A tibble with one row per product and columns:

organisationId

Character. Organisation identifier.

produktartId

Character. Product-type identifier.

nummer

Integer. Sequential product number.

name

Character. Product name.

artikelnummern

List. Article numbers (character vector).

typenAusfuehrungen

List. Type/model variants (character vector).

aufnahmeDatum

Character. Admission date (ISO-8601).

aenderungsDatum

Character. Last-modified date (ISO-8601).

zehnSteller

Character. Ten-digit product code.

herstellerName

Character. Manufacturer name.

istHerausgenommen

Logical. Whether product is withdrawn.

istAbrechnungsposition

Logical. Whether product is a billing item.

id

Character. Product identifier.

displayName

Character. Combined display label.

aufnahmeDatum_time

POSIXct. Parsed admission date (Europe/Berlin).

aenderungsDatum_time

POSIXct. Parsed last-modified date (Europe/Berlin).

Details

Returns the full product list (large payload). API documentation: https://github.com/bundesAPI/hilfsmittel-api.

See also

Other Hilfsmittel: hilfsmittel_nachweisschema(), hilfsmittel_produkt(), hilfsmittel_produktart(), hilfsmittel_produktgruppe(), hilfsmittel_tree(), hilfsmittel_untergruppe()

Examples

if (FALSE) { # \dontrun{
hilfsmittel_produkte()
} # }