List DiGA catalog entries

List DiGA catalog entries

Usage

diga_catalog_entries(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

params

Named list of FHIR search parameters:

_count

Maximum bundle size per request (integer, default 1000).

_profile

FHIR profile URL used to restrict resource type (character).

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 catalog entry and columns:

resourceType

Character. FHIR resource type, always "CatalogEntry".

id

Character. FHIR resource identifier.

status

Character. Entry status.

orderable

Logical. Whether the entry is orderable.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

type

List. Catalog entry type coding.

referencedItem

List. Referenced device definition.

extension

List. FHIR profile extensions.

additionalCharacteristic

List. Additional characteristics.

See also

bunddev_parameters() to inspect available query parameters.

Other DiGA: diga_charge_item_definitions(), diga_device_definitions(), diga_organizations(), diga_questionnaire_responses(), diga_questionnaires()