camel-fhir-kafka-connector source configuration

Connector Description: Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard.

When using camel-fhir-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-fhir-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.fhir.CamelFhirSourceConnector

The camel-fhir source connector supports 71 options, which are listed below.

Name Description Default Priority

camel.source.path.apiName

Required What kind of operation to perform One of: [CAPABILITIES] [CREATE] [DELETE] [HISTORY] [LOAD_PAGE] [META] [OPERATION] [PATCH] [READ] [SEARCH] [TRANSACTION] [UPDATE] [VALIDATE].

Enum values:

  • CAPABILITIES

  • CREATE

  • DELETE

  • HISTORY

  • LOAD_PAGE

  • META

  • OPERATION

  • PATCH

  • READ

  • SEARCH

  • TRANSACTION

  • UPDATE

  • VALIDATE

HIGH

camel.source.path.methodName

Required What sub operation to use for the selected operation.

HIGH

camel.source.endpoint.encoding

Encoding to use for all request One of: [JSON] [XML].

Enum values:

  • JSON

  • XML

MEDIUM

camel.source.endpoint.fhirVersion

The FHIR Version to use One of: [DSTU2] [DSTU2_HL7ORG] [DSTU2_1] [DSTU3] [R4] [R5].

Enum values:

  • DSTU2

  • DSTU2_HL7ORG

  • DSTU2_1

  • DSTU3

  • R4

  • R5

"R4"

MEDIUM

camel.source.endpoint.inBody

Sets the name of a parameter to be passed in the exchange In Body.

MEDIUM

camel.source.endpoint.log

Will log every requests and responses.

false

MEDIUM

camel.source.endpoint.prettyPrint

Pretty print all request.

false

MEDIUM

camel.source.endpoint.serverUrl

The FHIR server base URL.

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.pollStrategy

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.

MEDIUM

camel.source.endpoint.client

To use the custom client.

MEDIUM

camel.source.endpoint.clientFactory

To use the custom client factory.

MEDIUM

camel.source.endpoint.compress

Compresses outgoing (POST/PUT) contents to the GZIP format.

false

MEDIUM

camel.source.endpoint.connectionTimeout

How long to try and establish the initial TCP connection (in ms).

"10000"

MEDIUM

camel.source.endpoint.deferModelScanning

When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed.

false

MEDIUM

camel.source.endpoint.fhirContext

FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly.

MEDIUM

camel.source.endpoint.forceConformanceCheck

Force conformance check.

false

MEDIUM

camel.source.endpoint.sessionCookie

HTTP session cookie to add to every request.

MEDIUM

camel.source.endpoint.socketTimeout

How long to block for individual read/write operations (in ms).

"10000"

MEDIUM

camel.source.endpoint.summary

Request that the server modify the response using the _summary param One of: [COUNT] [TEXT] [DATA] [TRUE] [FALSE].

Enum values:

  • COUNT

  • TEXT

  • DATA

  • TRUE

  • FALSE

MEDIUM

camel.source.endpoint.validationMode

When should Camel validate the FHIR Server’s conformance statement One of: [NEVER] [ONCE].

Enum values:

  • NEVER

  • ONCE

"ONCE"

MEDIUM

camel.source.endpoint.proxyHost

The proxy host.

MEDIUM

camel.source.endpoint.proxyPassword

The proxy password.

MEDIUM

camel.source.endpoint.proxyPort

The proxy port.

MEDIUM

camel.source.endpoint.proxyUser

The proxy username.

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

MEDIUM

camel.source.endpoint.backoffMultiplier

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF].

Enum values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

"TRACE"

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler.

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS].

Enum values:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessToken

OAuth access token.

MEDIUM

camel.source.endpoint.password

Username to use for basic authentication.

MEDIUM

camel.source.endpoint.username

Username to use for basic authentication.

MEDIUM

camel.component.fhir.encoding

Encoding to use for all request One of: [JSON] [XML].

Enum values:

  • JSON

  • XML

MEDIUM

camel.component.fhir.fhirVersion

The FHIR Version to use One of: [DSTU2] [DSTU2_HL7ORG] [DSTU2_1] [DSTU3] [R4] [R5].

Enum values:

  • DSTU2

  • DSTU2_HL7ORG

  • DSTU2_1

  • DSTU3

  • R4

  • R5

"R4"

MEDIUM

camel.component.fhir.log

Will log every requests and responses.

false

MEDIUM

camel.component.fhir.prettyPrint

Pretty print all request.

false

MEDIUM

camel.component.fhir.serverUrl

The FHIR server base URL.

MEDIUM

camel.component.fhir.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.component.fhir.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.fhir.client

To use the custom client.

MEDIUM

camel.component.fhir.clientFactory

To use the custom client factory.

MEDIUM

camel.component.fhir.compress

Compresses outgoing (POST/PUT) contents to the GZIP format.

false

MEDIUM

camel.component.fhir.configuration

To use the shared configuration.

MEDIUM

camel.component.fhir.connectionTimeout

How long to try and establish the initial TCP connection (in ms).

"10000"

MEDIUM

camel.component.fhir.deferModelScanning

When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed.

false

MEDIUM

camel.component.fhir.fhirContext

FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly.

MEDIUM

camel.component.fhir.forceConformanceCheck

Force conformance check.

false

MEDIUM

camel.component.fhir.sessionCookie

HTTP session cookie to add to every request.

MEDIUM

camel.component.fhir.socketTimeout

How long to block for individual read/write operations (in ms).

"10000"

MEDIUM

camel.component.fhir.summary

Request that the server modify the response using the _summary param One of: [COUNT] [TEXT] [DATA] [TRUE] [FALSE].

Enum values:

  • COUNT

  • TEXT

  • DATA

  • TRUE

  • FALSE

MEDIUM

camel.component.fhir.validationMode

When should Camel validate the FHIR Server’s conformance statement One of: [NEVER] [ONCE].

Enum values:

  • NEVER

  • ONCE

"ONCE"

MEDIUM

camel.component.fhir.proxyHost

The proxy host.

MEDIUM

camel.component.fhir.proxyPassword

The proxy password.

MEDIUM

camel.component.fhir.proxyPort

The proxy port.

MEDIUM

camel.component.fhir.proxyUser

The proxy username.

MEDIUM

camel.component.fhir.accessToken

OAuth access token.

MEDIUM

camel.component.fhir.password

Username to use for basic authentication.

MEDIUM

camel.component.fhir.username

Username to use for basic authentication.

MEDIUM

The camel-fhir source connector has no converters out of the box.

The camel-fhir source connector has no transforms out of the box.

The camel-fhir source connector has no aggregation strategies out of the box.

Back to top