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

Synchronize Data Between FHIR and Kizen in an Agentic Workflow

Audience: Admins, Developers, Solution Architects

Purpose: Explains how to add FHIR action steps to Agentic Workflows in Kizen to synchronize live FHIR data between FHIR and Kizen

Overview

Caution: This setup reflects Kizen's default configuration. Your administrator may have customized your layout, so columns or navigation may appear differently. Trial accounts may have limited features.

With the FHIR integration, you can synchronize data between FHIR® and Kizen directly from an Agentic Workflow.

Before You Begin

To synchronize data between FHIR and Kizen in an Agentic Workflow, you need:

  • A connection from Kizen to your FHIR server. See Set Up FHIR in Kizen for more information.

  • An administrator account in Kizen to create Objects for field mapping. See Set Up FHIR in Kizen for details.

Synchronize Data Between FHIR and Kizen in an Agentic Workflow

To synchronize data between FHIR and Kizen 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 function to perform

In the Action Settings section of the Add Action modal, select the Action dropdown menu, and do one of the following:

  • To insert a FHIR resource as a Kizen record, select Create Kizen Record, and set up the action. For more information, see Set Up a Create Kizen Record Action below.

  • To prepare a batch of FHIR resources for import into Kizen, select Parse FHIR Resource, and set up the action. For more information, see Set Up a Parse FHIR Resource Action below.

  • To import a batch of parsed FHIR resources into Kizen, select Batch Import via SmartConnector, and set up the action. For more information, see Set Up a Batch Import via SmartConnector Action below.

5

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
6

Save the FHIR action

Select Save.

Set Up a Create Kizen Record Action

The Create Kizen Record action adds the specified FHIR resource to Kizen as a Record.

To set up a Create Kizen Record action:

1

Create Objects

Create Objects in Kizen for the FHIR resources that you want to add and then map the Custom Fields of these Kizen Objects to the corresponding fields on the FHIR side. For the procedure, see Set Up FHIR in Kizen.

2

Configure the source for the FHIR resource's JSON string

Find the FHIR Resource field in the Script Inputs section of the modal, open its Input Source dropdown menu, select the source of the JSON string that describes the FHIR resource, and then configure the source with the additional controls that appear.

The script inputs for the Create Kizen Record action in the Add Action modal
3

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 Create Kizen Record action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

Kizen Record ID

String

The ID of the Kizen Record

No

Mapped Field Count

Number

The number of mapped fields in the Kizen Record

No

Total Field Count

Number

The total number of fields in the Kizen Record

No

Unmapped Fields

String

A comma-separated list of the names of the unmapped fields in the Kizen Record

No

Set Up a Parse FHIR Resource Action

The Parse FHIR Resource action converts one or more FHIR resources into a JSONL string for import into Kizen through a SmartConnector.

For more information, see Set Up a Batch Import via SmartConnector Action.

To set up a Parse FHIR Resource action:

1

Create Objects

Create Objects in Kizen for the FHIR resources that you want to add and then map the Custom Fields of these Kizen Objects to the corresponding fields on the FHIR side. For the procedure, see Set Up FHIR in Kizen.

2

Configure the sources for the script inputs

For each of the fields in the Script Inputs section of the Add Action modal, select the source of the field's value from the Input Source dropdown menu, and then configure the source with the additional controls that appear.

The script inputs for the Parse FHIR Resource action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

FHIR Resource

String

A JSON string that describes one or more FHIR resources. Take this value from the output of a FHIR Read or FHIR Search step.

Yes

Resource Type

String

The type of the FHIR resource to parse in PascalCase, such as Patient or PractitionerRole.

Yes

3

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 Parse FHIR Resource action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

Mapped Field Count

Number

The number of mapped fields in the parsed FHIR resource

No

Parsed Records

String

A stringified array in JSONL format describing the parsed FHIR resources

No

Record Count

Number

The number of parsed FHIR resources

No

Unmapped Fields

String

A comma-separated list of the names of the unmapped fields in the parsed FHIR resource

No

Set Up a Batch Import via SmartConnector Action

The Batch Import via SmartConnector action sends the parsed FHIR resources that you created with the Parse FHIR Resource action to the specified SmartConnector for import into Kizen.

Note: The input of the Batch Import via SmartConnector action is the output of the Parse FHIR Resource action. So be sure to add and configure a parse action before you use the batch import action in your Agentic Workflow.

To set up a Batch Import via SmartConnector action:

1

Configure the sources for the script inputs

For each of the fields in the Script Inputs section of the Add Action modal, select the source of the field's value from the Input Source dropdown menu, and then configure the source with the additional controls that appear.

The script inputs for the Batch Import via SmartConnector action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

Parsed FHIR Records

String

A stringified array in JSONL format describing the parsed FHIR resources. Use the output from the Parse FHIR Resource action here.

Yes

SmartConnector API Name

String

The API name of the Kizen SmartConnector to use.

Yes

2

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 Batch Import via SmartConnector action in the Add Action modal

The fields are as follows:

Field
Type
Description
Required?

Records Sent

Number

The number of FHIR resources imported to Kizen through the SmartConnector

No

Response Status Code

Number

The HTTP status code that the API response returned

No

Note: SmartConnectors have a maximum payload of 256 kilobytes.

What's Next

Continue to Troubleshoot FHIR for details on how to fix common technical issues.

Related Topics

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.

PreviousRead and Write FHIR Data in an Agentic Workflow
NextTroubleshoot FHIR

Last updated

Was this helpful?