Overview

The FHIR (Fast Healthcare Interoperability Resources) connector for Bizagi is available for download at Bizagi Connectors Xchange.

Through this connector, you will be able to connect your Bizagi processes to your FHIR's services in order to integrate your Healthcare data securely and in a standard way.

This connector connects to implementations of such services as defined by the HL7 organization (Health Level Seven International) within its specification found at https://www.hl7.org/fhir/, while allowing you to: Register, update, delete or query information from the different healthcare managed data (represented as resources), such as: appointments, care plans, patients, diagnostic reports, schedules, slots, practitioners, organizations, or devices.

For more information about this connector's capabilities, visit Bizagi Connectors Xchange.

Before you start

In order to test and use this connector, you will need:

1.Bizagi Studio previously installed.

2.This connector previously installed, via the Connectors Xchange as described at https://help.bizagi.com/platform/en/index.html?Connectors_Xchange.htm, or through a manual installation as described at https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.

3.Implementation of the FHIR's services and an authorized account which connects to those FHIR's services.

Configuring the connector

In order to configure the connector (i.e its authentication parameters), follow the steps presented at the Configuration chapter in https://help.bizagi.com/platform/en/index.html?connectors_setup.htm

For this configuration, consider the following authentication parameters:

•Authentication method: custom.

•Tenant: The Domain name for your authentication.

•Client_ID: The generated client Id for your authorized application to consume such services.

•Client_Secret: The generated client secret authorized to consume such services (paired to the Client ID).

•Resource: URL location where the Resources are found.

•URL_API: URL location where the Restful API is at.

FHIR_00

Using the connector

This connector features many available methods of FHIR's services allowing the interoperability of healthcare data represented as resources (as presented at http://hl7.org/implement/standards/fhir/resourcelist.html), which cover up their CRUD possibilities (Create, Retrieve, Update, Delete).

The complete list of available actions will not be illustrated through explicit examples; this document will illustrate the use of such actions by using patients as example (the Get patient, Create/Update patient, and Delete patient actions).

Refer to the following table for information on the complete list of actions.

RESOURCE	DATA STRUCTURE (further details)	ACTION
Patient	http://hl7.org/implement/standards/fhir/patient.html. A detailed example of the data structure is provided below.	Create/Update patient, Get patient, Delete patient.
Appointment	http://hl7.org/implement/standards/fhir/appointment.html A brief screenshot of the data structure is provided in the last section.	Create/Update appointment, Get appointment, Delete appointment.
Careplan	http://hl7.org/implement/standards/fhir/careplan.html A brief screenshot of the data structure is provided in the last section.	Create/Update care plan, Get care plan, Delete care plan.
Diagnostic Report	http://hl7.org/implement/standards/fhir/diagnosticreport.html A brief screenshot of the data structure is provided in the last section.	Create/Update Diagnostic Report, Get Diagnostic Report, Delete Diagnostic Report.
Slot	http://hl7.org/implement/standards/fhir/slot.html A brief screenshot of the data structure is provided in the last section.	Create/Update slot, Get slot, Delete slot.
Schedule	http://hl7.org/implement/standards/fhir/schedule.html A brief screenshot of the data structure is provided in the last section.	Create/Update schedule, Get schedule, Delete schedule.
Practitioner	http://hl7.org/implement/standards/fhir/practitioner.html A brief screenshot of the data structure is provided in the last section.	Create/Update practitioner, Get practitioner, Delete practitioner.
Organization	http://hl7.org/implement/standards/fhir/organization.html A brief screenshot of the data structure is provided in the last section.	Create/Update organization, Get organization, Delete organization.
Device	http://hl7.org/implement/standards/fhir/device.html A brief screenshot of the data structure is provided in the last section.	Create/Update device, Get device, Delete device.

All actions to fetch a given resource (e.g, get patient, get schedule, get practitioner), will need that resource's ID as input, and will send back details as shown in the link above for that resource.

All actions to create or update a resource (e.g, create/update patient, create/update schedule, create/update practitioner), will need that resource's ID as input along with the main or compulsory data needed for a new record, and it will send back a confirmation message of the operation's success.

All actions to delete a given resource (e.g, delete patient, delete schedule, delete practitioner), will need that resource's ID as input, and will send back a confirmation message of the operation's success.

To learn overall how/where to configure the use of a connector, refer to https://help.bizagi.com/platform/en/index.html?Connectors_Studio.htm.

Create/update patient

This action allows you to register a patient (creates a new record if such patient is not in the system) or update its information in the system.

FHIR_b_01

To configure its inputs, consider mapping all relevant bits of information of the initial record of the patient such as:

•Patient ID: The identifier for that given patient.

•NameText: The given name of that patient.

•NameFamily: The last name of that patient.

•Phone: The phone number for that given patient.

•Email: The e-mail address for that given patient.

•Birthdate: The date of birth for that given patient.

Note that the above list is not comprehensive, and you may map further details as needed.

FHIR_b_02

To configure its outputs when getting started and testing, you may map Message, which returns if the invocation was successful or not.

FHIR_b_03

Get patient

This action allows you to query the information of a given patient.

FHIR_a_01

To configure its inputs, consider mapping its main identifier (patient ID) so that the exact patient you are looking for is appropriately fetched:

FHIR_a_02

To configure its outputs when getting started and testing, you may map all relevant bits of information of the initial record of the patient such as:

•Text (from the Name element): The given name of that patient.

•Family (from the Name element): The last name of that patient.

•Gender: The gender registered for that given patient.

•Phone: The phone number for that given patient.

•Email: The e-mail address for that given patient.

•Birthdate: The date of birth for that given patient.

Note that the above list is not comprehensive, and you may map further details as needed.

FHIR_a_03

Delete patient

This action allows you to delete a patient in the system.

FHIR_c_01

To configure its inputs, consider mapping its main identifier (patient ID) so that the exact patient you are looking for is appropriately deleted.

Note that your employed account will need adequate rights for this operation.

FHIR_c_02

To configure its outputs when getting started and testing, you may map Message, which returns if the invocation was successful or not.

FHIR_c_03

Further information

The following images provide a quick illustration on the expected information (data structure) of the resources other than the patient resource shown above.

appointment

Uses the following information:

FHIR_appointment