Get Hilfsmittel subgroup details

Get Hilfsmittel subgroup details

Usage

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

Arguments

id

Untergruppe id.

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 for the requested subgroup and columns:

id

Character. Subgroup identifier.

versionId

Character. Internal version identifier.

nummer

Integer. Subgroup number.

anwendungsortId

Character. Application-site identifier.

bezeichnung

Character. Subgroup name.

produktgruppeId

Character. Parent product-group identifier.

nachweisschemaId

Character. Verification-schema identifier.

sechsSteller

Character. Six-digit code.

isNnElement

Logical. Internal flag (usage unclear).

produktgruppe

Numeric. Always NA.

anwendungsort

Numeric. Always NA.

aufnahmeDatum

Character. Admission date (ISO-8601).

aenderungsDatum

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

aufnahmeDatum_time

POSIXct. Parsed admission date (Europe/Berlin).

aenderungsDatum_time

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

Details

Returns details for a subgroup (Untergruppe). API documentation: https://github.com/bundesAPI/hilfsmittel-api.

See also

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

Examples

if (FALSE) { # \dontrun{
hilfsmittel_untergruppe("c92d1976-d3cb-4b9f-bcdf-805272a9ea86")
} # }