tx_designation {pathling}

Get designations for codings

Description

Takes a Coding column as its input. Returns a Column that contains the values of designations (strings) for this coding that match the specified use and language. If the language is not provided, then all designations with the specified type are returned regardless of their language.

Usage

tx_designation(coding, use = NULL, language = NULL)

Arguments

coding

A Column containing a struct representation of a Coding.

use

The code with the use of the designations.

language

The language of the designations.

Value

The Column containing the result of the operation (array of strings with designation values).

See Also

Pathling documentation - Retrieving designations

Examples

pc <- pathling_connect()

# Get the (first) SNOMED CT "Fully specified name" ('900000000000003001')  
# for the first coding of the Condition resource, in the 'en' language.
pc %>% pathling_example_resource('Condition') %>% 
     sparklyr::mutate(
            id, 
            designation = (!!tx_designation(code[['coding']][[0]], 
                     !!tx_to_snomed_coding('900000000000003001'), language = 'en'))[[0]], 
            .keep='none')
pathling_disconnect(pc)