fhir_authenticate

This function is a wrapper to create an <a href="https://httr.r-lib.org/reference/Token-class.html">httr::Token</a> object for authentication with OAuth2/OpenID Connect.
Internally, it calls <code><a href="https://httr.r-lib.org/reference/oauth_app.html">httr::oauth_app()</a></code>, <code><a href="https://httr.r-lib.org/reference/oauth_endpoint.html">httr::oauth_endpoint()</a></code> and <code><a href="https://httr.r-lib.org/reference/oauth2.0_token.html">httr::oauth2.0_token()</a></code> to create a token that can
then be used in fhir_search.

Useful tools for conveniently downloading FHIR resources in xml format
and converting them to R data.frames. The package uses FHIR-search to download bundles
from a FHIR server, provides functions to save and read xml-files containing such bundles
and allows flattening the bundles to data.frames using XPath expressions. FHIR® is the registered trademark
of HL7 and is used with the permission of HL7. Use of the FHIR trademark does not constitute endorsement of this product by HL7.

Julia Palm

fhircrackr

Handling HL7 FHIR® Resources in R

Thomas Peschel

Jens Przybilla

Frank Meineke

fhir_authenticate function

<dl><dt>secret</dt>
<dd>The consumer/client secret, belonging to <code>key</code>.</dd>
<dt>key</dt>
<dd>Consumer key, also called client ID.
For Keycloak this would for instance be the Keycloak client, e.g. "postman".</dd>
<dt>base_url</dt>
<dd>The URL the user will be redirected to after authorization is complete.
This will usually be the base url of you FHIR server.</dd>
<dt>access</dt>
<dd>The url used to exchange unauthenticated for authenticated token.
This can be identical to <code>authorize</code>.</dd>
<dt>authorize</dt>
<dd>The url to send the client for authorization.</dd>
<dt>query_authorize_extra</dt>
<dd>A named list holding query parameters to append to initial auth page query.
Could hold info about user identity and scope for keycloak like this:
<div class="sourceCode"></div><pre><code>list(scope = "openid",
 grant_type = "password",
 username = "fhir-user",
 password = "fhirtest")
</code></pre></dd></dl>

Arguments

This function is a wrapper to create an <a href='https://httr.r-lib.org/reference/Token-class.html'>httr::Token</a> object for authentication with OAuth2/OpenID Connect.
Internally, it calls <code><a href='https://httr.r-lib.org/reference/oauth_app.html'>httr::oauth_app()</a></code>, <code><a href='https://httr.r-lib.org/reference/oauth_endpoint.html'>httr::oauth_endpoint()</a></code> and <code><a href='https://httr.r-lib.org/reference/oauth2.0_token.html'>httr::oauth2.0_token()</a></code> to create a token that can
then be used in fhir_search.

Create token for Authentication — fhir_authenticate

<dl>

<dt>secret</dt>
<dd>The consumer/client secret, belonging to <code>key</code>.</dd>


<dt>key</dt>
<dd>Consumer key, also called client ID.
For Keycloak this would for instance be the Keycloak client, e.g. "postman".</dd>


<dt>base_url</dt>
<dd>The URL the user will be redirected to after authorization is complete.
This will usually be the base url of you FHIR server.</dd>


<dt>access</dt>
<dd>The url used to exchange unauthenticated for authenticated token.
This can be identical to <code>authorize</code>.</dd>


<dt>authorize</dt>
<dd>The url to send the client for authorization.</dd>


<dt>query_authorize_extra</dt>
<dd>A named list holding query parameters to append to initial auth page query.
Could hold info about user identity and scope for keycloak like this:
<div class="sourceCode"><pre><code>list(scope = "openid",
 grant_type = "password",
 username = "fhir-user",
 password = "fhirtest")
</code></pre></div></dd>

</dl>

fhir_authenticate: Create token for Authentication

Description

Usage

Arguments