FHIR

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

Metadata

Property	Value
Scheme	`fhir`
Support Level	Stable
Labels	api
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-fhir</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`apiName`	object	✓		What kind of operation to perform
`methodName`	string	✓		What sub operation to use for the selected operation
`encoding`	string			Encoding to use for all request
`fhirVersion`	string		`R4`	The FHIR Version to use
`inBody`	string			Sets the name of a parameter to be passed in the exchange In Body
`log`	boolean		`false`	Will log every requests and responses
`prettyPrint`	boolean		`false`	Pretty print all request
`serverUrl`	string			The FHIR server base URL
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object			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.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			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.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`client`	object			To use the custom client
`clientFactory`	object			To use the custom client factory
`compress`	boolean		`false`	Compresses outgoing (POST/PUT) contents to the GZIP format
`connectionTimeout`	integer		`10000`	How long to try and establish the initial TCP connection (in ms)
`deferModelScanning`	boolean		`false`	When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed.
`fhirContext`	object			FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly.
`forceConformanceCheck`	boolean		`false`	Force conformance check
`sessionCookie`	string			HTTP session cookie to add to every request
`socketTimeout`	integer		`10000`	How long to block for individual read/write operations (in ms)
`summary`	string			Request that the server modify the response using the _summary param
`validationMode`	string		`ONCE`	When should Camel validate the FHIR Server's conformance statement
`proxyHost`	string			The proxy host
`proxyPassword`	string			The proxy password
`proxyPort`	integer			The proxy port
`proxyUser`	string			The proxy username
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			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.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	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.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`accessToken`	string			OAuth access token
`password`	string			Password to use for basic authentication
`username`	string			Username to use for basic authentication