Get a value set as a relation

Resolves a value set to its membership and returns it as a relation that Spark SQL can join to, as described in the SQL on FHIR Terminology in SQL page. The relation has one row per member and the columns system, version, code, display and inactive; system and code are never null.

pathling_value_set(pc, canonical, max_members = NULL)

Arguments

pc

The PathlingContext object.

canonical

The canonical URL of the value set, optionally with a |version suffix.

max_members

The largest membership accepted. When NULL, 100,000 members are accepted. Defaults to NULL.

Value

A Spark DataFrame containing the value set relation.

Details

The membership is obtained from the configured terminology layer when this function is called, so every use of the relation sees the same membership. A value set that cannot be resolved, or whose membership cannot be determined or exceeds the cap, is an error.

See also

Other terminology relation functions: pathling_concept_map(), pathling_concept_map_from_json(), pathling_value_set_from_json()