fhir source Fhir Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive data from Fhir server.

Configuration Options

The following table summarizes the configuration options available for the fhir-source Kamelet:

Property Name Description Type Default Example

password

Password

Required The password to access the Fhir server.

string

serverUrl

Server URL

Required The Fhir server url.

string

username

Username

Required The username to access the Fhir server.

string

encoding

Encoding

Encoding to use for all request. Possible values are JSON and XML.

string

JSON

fhirVersion

Fhir Version

The FHIR Version to use. There are 6 enums and the value can be one of DSTU2, DSTU2_HL7ORG, DSTU2_1, DSTU3, R4, R5.

string

R4

prettyPrint

Json Pretty Print

Define if the Json must be pretty print or not.

boolean

true

url

URL

The Fhir resource type url.

string

/Patient

Dependencies

At runtime, the fhir-source Kamelet relies upon the presence of the following dependencies:

  • camel:fhir

  • camel:kamelet

Usage

This section describes how you can use the fhir-source.

Knative source

You can use the fhir-source Kamelet as a Knative source by binding it to a Knative object.

fhir-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: fhir-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: fhir-source
    properties:
      password: The Password
      serverUrl: The Server URL
      username: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the fhir-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f fhir-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind fhir-source -p "source.password=The Password" -p "source.serverUrl=The Server URL" -p "source.username=The Username" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka source

You can use the fhir-source Kamelet as a Kafka source by binding it to a Kafka topic.

fhir-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: fhir-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: fhir-source
    properties:
      password: The Password
      serverUrl: The Server URL
      username: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the fhir-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f fhir-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind fhir-source -p "source.password=The Password" -p "source.serverUrl=The Server URL" -p "source.username=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/fhir-source.kamelet.yaml

Back to top