camel-fhir-kafka-connector sink configuration
Connector Description: Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard.
When using camel-fhir-kafka-connector as sink 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 Sink connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.fhir.CamelFhirSinkConnectorThe camel-fhir sink connector supports 53 options, which are listed below.
| Name | Description | Default | Required | Priority |
|---|---|---|---|---|
camel.sink.path.apiName |
What kind of operation to perform One of: [CAPABILITIES] [CREATE] [DELETE] [HISTORY] [LOAD_PAGE] [META] [OPERATION] [PATCH] [READ] [SEARCH] [TRANSACTION] [UPDATE] [VALIDATE] |
null |
true |
HIGH |
camel.sink.path.methodName |
What sub operation to use for the selected operation |
null |
true |
HIGH |
camel.sink.endpoint.encoding |
Encoding to use for all request One of: [JSON] [XML] |
null |
false |
MEDIUM |
camel.sink.endpoint.fhirVersion |
The FHIR Version to use One of: [DSTU2] [DSTU2_HL7ORG] [DSTU2_1] [DSTU3] [R4] [R5] |
"R4" |
false |
MEDIUM |
camel.sink.endpoint.inBody |
Sets the name of a parameter to be passed in the exchange In Body |
null |
false |
MEDIUM |
camel.sink.endpoint.log |
Will log every requests and responses |
false |
false |
MEDIUM |
camel.sink.endpoint.prettyPrint |
Pretty print all request |
false |
false |
MEDIUM |
camel.sink.endpoint.serverUrl |
The FHIR server base URL |
null |
false |
MEDIUM |
camel.sink.endpoint.lazyStartProducer |
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. |
false |
false |
MEDIUM |
camel.sink.endpoint.client |
To use the custom client |
null |
false |
MEDIUM |
camel.sink.endpoint.clientFactory |
To use the custom client factory |
null |
false |
MEDIUM |
camel.sink.endpoint.compress |
Compresses outgoing (POST/PUT) contents to the GZIP format |
false |
false |
MEDIUM |
camel.sink.endpoint.connectionTimeout |
How long to try and establish the initial TCP connection (in ms) |
"10000" |
false |
MEDIUM |
camel.sink.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 |
false |
MEDIUM |
camel.sink.endpoint.fhirContext |
FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. |
null |
false |
MEDIUM |
camel.sink.endpoint.forceConformanceCheck |
Force conformance check |
false |
false |
MEDIUM |
camel.sink.endpoint.sessionCookie |
HTTP session cookie to add to every request |
null |
false |
MEDIUM |
camel.sink.endpoint.socketTimeout |
How long to block for individual read/write operations (in ms) |
"10000" |
false |
MEDIUM |
camel.sink.endpoint.summary |
Request that the server modify the response using the _summary param One of: [COUNT] [TEXT] [DATA] [TRUE] [FALSE] |
null |
false |
MEDIUM |
camel.sink.endpoint.validationMode |
When should Camel validate the FHIR Server’s conformance statement One of: [NEVER] [ONCE] |
"ONCE" |
false |
MEDIUM |
camel.sink.endpoint.proxyHost |
The proxy host |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyPassword |
The proxy password |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyPort |
The proxy port |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyUser |
The proxy username |
null |
false |
MEDIUM |
camel.sink.endpoint.accessToken |
OAuth access token |
null |
false |
MEDIUM |
camel.sink.endpoint.password |
Username to use for basic authentication |
null |
false |
MEDIUM |
camel.sink.endpoint.username |
Username to use for basic authentication |
null |
false |
MEDIUM |
camel.component.fhir.encoding |
Encoding to use for all request One of: [JSON] [XML] |
null |
false |
MEDIUM |
camel.component.fhir.fhirVersion |
The FHIR Version to use One of: [DSTU2] [DSTU2_HL7ORG] [DSTU2_1] [DSTU3] [R4] [R5] |
"R4" |
false |
MEDIUM |
camel.component.fhir.log |
Will log every requests and responses |
false |
false |
MEDIUM |
camel.component.fhir.prettyPrint |
Pretty print all request |
false |
false |
MEDIUM |
camel.component.fhir.serverUrl |
The FHIR server base URL |
null |
false |
MEDIUM |
camel.component.fhir.lazyStartProducer |
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. |
false |
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 |
false |
MEDIUM |
camel.component.fhir.client |
To use the custom client |
null |
false |
MEDIUM |
camel.component.fhir.clientFactory |
To use the custom client factory |
null |
false |
MEDIUM |
camel.component.fhir.compress |
Compresses outgoing (POST/PUT) contents to the GZIP format |
false |
false |
MEDIUM |
camel.component.fhir.configuration |
To use the shared configuration |
null |
false |
MEDIUM |
camel.component.fhir.connectionTimeout |
How long to try and establish the initial TCP connection (in ms) |
"10000" |
false |
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 |
false |
MEDIUM |
camel.component.fhir.fhirContext |
FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. |
null |
false |
MEDIUM |
camel.component.fhir.forceConformanceCheck |
Force conformance check |
false |
false |
MEDIUM |
camel.component.fhir.sessionCookie |
HTTP session cookie to add to every request |
null |
false |
MEDIUM |
camel.component.fhir.socketTimeout |
How long to block for individual read/write operations (in ms) |
"10000" |
false |
MEDIUM |
camel.component.fhir.summary |
Request that the server modify the response using the _summary param One of: [COUNT] [TEXT] [DATA] [TRUE] [FALSE] |
null |
false |
MEDIUM |
camel.component.fhir.validationMode |
When should Camel validate the FHIR Server’s conformance statement One of: [NEVER] [ONCE] |
"ONCE" |
false |
MEDIUM |
camel.component.fhir.proxyHost |
The proxy host |
null |
false |
MEDIUM |
camel.component.fhir.proxyPassword |
The proxy password |
null |
false |
MEDIUM |
camel.component.fhir.proxyPort |
The proxy port |
null |
false |
MEDIUM |
camel.component.fhir.proxyUser |
The proxy username |
null |
false |
MEDIUM |
camel.component.fhir.accessToken |
OAuth access token |
null |
false |
MEDIUM |
camel.component.fhir.password |
Username to use for basic authentication |
null |
false |
MEDIUM |
camel.component.fhir.username |
Username to use for basic authentication |
null |
false |
MEDIUM |
The camel-fhir sink connector has no converters out of the box.
The camel-fhir sink connector has no transforms out of the box.
The camel-fhir sink connector has no aggregation strategies out of the box.