For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authenticate to a FHIR Server in an Agentic Workflow

Overview

Once you set up the FHIR integration in Kizen, you can work with FHIR® data in an Agentic Workflow. However, for security, you must always begin by authenticating to your FHIR server whenever you want to read or write FHIR data.

Note: Authentication isn't necessary for data synchronization actions.


Before You Begin

To authenticate to a FHIR server in an Agentic Workflow, you need a connection from Kizen to your FHIR server. For more information, see Set Up FHIR in Kizen.


Authenticate to a FHIR Server in an Agentic Workflow

With the FHIR Authenticate action, the integration authenticates to your FHIR server using SMART Backend Services and returns an access token. You must include this token as an input in subsequent FHIR steps of the Agentic Workflow for reading or writing FHIR data.

Note: Always start with FHIR Authenticate before you add any steps to the Agentic Workflow for reading or writing FHIR data. These steps need the access token and the base URL of the FHIR server that the FHIR Authenticate action returns.

For data synchronization steps, you can omit this action.

To authenticate to a FHIR server in an Agentic Workflow:

1

Go to the Agentic Workflow builder

In the global navigation, select Agentic Workflows. Then, to open the builder, do one of the following:

  • Select New Agentic Workflow.

  • Select the name of an existing Agentic Workflow.

The New Agentic Workflow button on the Agentic Workflows page
2

Add an action to the Agentic Workflow

In the builder, select +, and then select Add Action.

The Add Action context menu item in the Agentic Workflow builder
3

Select the FHIR action

In the Add Action modal that appears, scroll to the Integration section, and select the FHIR connection card.

The FHIR connection card on the Add Action modal
4

Choose the authentication step

In the Action Settings section of the Add Action modal, select FHIR Authenticate from the Action dropdown menu.

5

Configure the source for the connection tag as needed

If you set up multiple FHIR environments to work with Kizen, the value of the Connection Tag field determines which of these connection to use. Find the Connection Tag field in the Script Inputs section of the modal, open its Input Source dropdown menu, select the source of its value, and then configure the source with the additional controls that appear. If you don't have multiple FHIR environments, you can skip this step.

The script inputs for the FHIR Authenticate action in the Add Action modal
6

Configure the destinations for the script outputs

For each of the fields in the Script Outputs section of the modal, select the destination of the field's value from the Output Destination dropdown menu, and then configure the destination with the additional controls that appear.

The script outputs for the FHIR Authenticate action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

Access Token

String

The access token to authorize the connection

No

FHIR Base URL

String

The base URL of the FHIR server

No

FHIR Version

String

The version of FHIR as a string, such as R4

No

Note: Be sure to keep the values of Access Token and FHIR Base URL for subsequent FHIR actions.

7

Configure error handling

In the Error Handling section of the modal, specify how to handle errors in this step of the Agentic Workflow.

The error handling options in the Add Action modal
8

Save the FHIR action

Select Save.


What's Next

Continue to Read and Write FHIR Data in an Agentic Workflow to learn how to read and write FHIR data in Kizen.


HL7, FHIR, and the FHIR FLAME DESIGN are the registered trademarks of Health Level Seven International, and their use does not constitute endorsement by HL7.

Last updated

Was this helpful?