Chapter 31. FHIR Both producer and consumer are supported The FHIR component integrates with the HAPI-FHIR library which is an open-source implementation of the FHIR (Fast Healthcare Interoperability Resources) specification in Java. 31.1. Dependencies When using fhir with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-fhir-starter</artifactId> </dependency> 31.2. URI Format The FHIR Component uses the following URI format: Endpoint prefix can be one of: capabilities create delete history load-page meta operation patch read search transaction update validate 31.3. Configuring Options Camel components are configured on two levels: Component level Endpoint level 31.3.1. Component Level Options The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on. Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all. You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code. 31.3.2. Endpoint Level Options At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both. You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java. When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings. Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code. 31.4. Component Options The FHIR component supports 27 options, which are listed below. Name Description Default Type encoding (common) Encoding to use for all request. Enum values: JSON XML String fhirVersion (common) The FHIR Version to use. Enum values: DSTU2 DSTU2_HL7ORG DSTU2_1 DSTU3 R4 R5 R4 String log (common) Will log every requests and responses. false boolean prettyPrint (common) Pretty print all request. false boolean serverUrl (common) The FHIR server base URL. String bridgeErrorHandler (consumer) 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 boolean lazyStartProducer (producer) 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 boolean autowiredEnabled (advanced) 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 boolean client (advanced) To use the custom client. IGenericClient clientFactory (advanced) To use the custom client factory. IRestfulClientFactory compress (advanced) Compresses outgoing (POST/PUT) contents to the GZIP format. false boolean configuration (advanced) To use the shared configuration. FhirConfiguration connectionTimeout (advanced) How long to try and establish the initial TCP connection (in ms). 10000 Integer deferModelScanning (advanced) 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 boolean fhirContext (advanced) FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. FhirContext forceConformanceCheck (advanced) Force conformance check. false boolean sessionCookie (advanced) HTTP session cookie to add to every request. String socketTimeout (advanced) How long to block for individual read/write operations (in ms). 10000 Integer summary (advanced) Request that the server modify the response using the _summary param. Enum values: COUNT TEXT DATA TRUE FALSE String validationMode (advanced) When should Camel validate the FHIR Server's conformance statement. Enum values: NEVER ONCE ONCE String proxyHost (proxy) The proxy host. String proxyPassword (proxy) The proxy password. String proxyPort (proxy) The proxy port. Integer proxyUser (proxy) The proxy username. String accessToken (security) OAuth access token. String password (security) Username to use for basic authentication. String username (security) Username to use for basic authentication. String 31.5. Endpoint Options The FHIR endpoint is configured using URI syntax: with the following path and query parameters: 31.5.1. Path Parameters (2 parameters) Name Description Default Type apiName (common) Required What kind of operation to perform. Enum values: CAPABILITIES CREATE DELETE HISTORY LOAD_PAGE META OPERATION PATCH READ SEARCH TRANSACTION UPDATE VALIDATE FhirApiName methodName (common) Required What sub operation to use for the selected operation. String 31.5.2. Query Parameters (44 parameters) Name Description Default Type encoding (common) Encoding to use for all request. Enum values: JSON XML String fhirVersion (common) The FHIR Version to use. Enum values: DSTU2 DSTU2_HL7ORG DSTU2_1 DSTU3 R4 R5 R4 String inBody (common) Sets the name of a parameter to be passed in the exchange In Body. String log (common) Will log every requests and responses. false boolean prettyPrint (common) Pretty print all request. false boolean serverUrl (common) The FHIR server base URL. String bridgeErrorHandler (consumer) 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 boolean sendEmptyMessageWhenIdle (consumer) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. false boolean exceptionHandler (consumer (advanced)) 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. ExceptionHandler exchangePattern (consumer (advanced)) Sets the exchange pattern when the consumer creates an exchange. Enum values: InOnly InOut InOptionalOut ExchangePattern pollStrategy (consumer (advanced)) 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. PollingConsumerPollStrategy lazyStartProducer (producer) 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 boolean client (advanced) To use the custom client. IGenericClient clientFactory (advanced) To use the custom client factory. IRestfulClientFactory compress (advanced) Compresses outgoing (POST/PUT) contents to the GZIP format. false boolean connectionTimeout (advanced) How long to try and establish the initial TCP connection (in ms). 10000 Integer deferModelScanning (advanced) 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 boolean fhirContext (advanced) FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. FhirContext forceConformanceCheck (advanced) Force conformance check. false boolean sessionCookie (advanced) HTTP session cookie to add to every request. String socketTimeout (advanced) How long to block for individual read/write operations (in ms). 10000 Integer summary (advanced) Request that the server modify the response using the _summary param. Enum values: COUNT TEXT DATA TRUE FALSE String validationMode (advanced) When should Camel validate the FHIR Server's conformance statement. Enum values: NEVER ONCE ONCE String proxyHost (proxy) The proxy host. String proxyPassword (proxy) The proxy password. String proxyPort (proxy) The proxy port. Integer proxyUser (proxy) The proxy username. String backoffErrorThreshold (scheduler) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. int backoffIdleThreshold (scheduler) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. int backoffMultiplier (scheduler) 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 actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. int delay (scheduler) Milliseconds before the poll. 500 long greedy (scheduler) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the run polled 1 or more messages. false boolean initialDelay (scheduler) Milliseconds before the first poll starts. 1000 long repeatCount (scheduler) 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. 0 long runLoggingLevel (scheduler) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. Enum values: TRACE DEBUG INFO WARN ERROR OFF TRACE LoggingLevel scheduledExecutorService (scheduler) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. ScheduledExecutorService scheduler (scheduler) To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. none Object schedulerProperties (scheduler) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. Map startScheduler (scheduler) Whether the scheduler should be auto started. true boolean timeUnit (scheduler) Time unit for initialDelay and delay options. Enum values: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS MILLISECONDS TimeUnit useFixedDelay (scheduler) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. true boolean accessToken (security) OAuth access token. String password (security) Username to use for basic authentication. String username (security) Username to use for basic authentication. String 31.6. API Parameters (13 APIs) The @FHIR endpoint is an API based component and has additional parameters based on which API name and API method is used. The API name and API method is located in the endpoint URI as the apiName/methodName path parameters: There are 13 API names as listed in the table below: API Name Type Description capabilities Both API to Fetch the capability statement for the server create Both API for the create operation, which creates a new resource instance on the server delete Both API for the delete operation, which performs a logical delete on a server resource history Both API for the history method load-page Both API that Loads the / bundle of resources from a paged set, using the link specified in the link type= tag within the atom bundle meta Both API for the meta operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server operation Both API for extended FHIR operations patch Both API for the patch operation, which performs a logical patch on a server resource read Both API method for read operations search Both API to search for resources matching a given set of criteria transaction Both API for sending a transaction (collection of resources) to the server to be executed as a single unit update Both API for the update operation, which performs a logical delete on a server resource validate Both API for validating resources Each API is documented in the following sections to come. 31.6.1. API: capabilities Both producer and consumer are supported The capabilities API is defined in the syntax as follows: The method is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description ofType Retrieve the conformance statement using the given model type 31.6.1.1. Method ofType Signatures: org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/ofType API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map type The model type Class In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.2. API: create Both producer and consumer are supported The create API is defined in the syntax as follows: The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description resource Creates a IBaseResource on the server 31.6.2.1. Method resource Signatures: ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resource API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map preferReturn Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() , may be null PreferReturnEnum resource The resource to create IBaseResource resourceAsString The resource to create String url The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366, may be null String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.3. API: delete Both producer and consumer are supported The delete API is defined in the syntax as follows: The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description resource Deletes the given resource resourceById Deletes the resource by resource type e resourceConditionalByUrl Specifies that the delete should be performed as a conditional delete against a given search URL 31.6.3.1. Method resource Signatures: org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resource API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map resource The IBaseResource to delete IBaseResource 31.6.3.2. Method resourceById Signatures: org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(String type, String stringId, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resourceById API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The IIdType referencing the resource IIdType stringId It's id String type The resource type e.g Patient String 31.6.3.3. Method resourceConditionalByUrl Signatures: org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceConditionalByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resourceConditionalByUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map url The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366 String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.4. API: history Both producer and consumer are supported The history API is defined in the syntax as follows: The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description onInstance Perform the operation across all versions of a specific resource (by ID and type) on the server onServer Perform the operation across all versions of all resources of all types on the server onType Perform the operation across all versions of all resources of the given type on the server 31.6.4.1. Method onInstance Signatures: org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onInstance API method has the parameters listed in the table below: Parameter Description Type count Request that the server return only up to theCount number of resources, may be NULL Integer cutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL Date extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map iCutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL IPrimitiveType id The IIdType which must be populated with both a resource type and a resource ID at IIdType returnType Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server. Class 31.6.4.2. Method onServer Signatures: org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onServer API method has the parameters listed in the table below: Parameter Description Type count Request that the server return only up to theCount number of resources, may be NULL Integer cutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL Date extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map iCutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL IPrimitiveType returnType Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server. Class 31.6.4.3. Method onType Signatures: org.hl7.fhir.instance.model.api.IBaseBundle onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onType API method has the parameters listed in the table below: Parameter Description Type count Request that the server return only up to theCount number of resources, may be NULL Integer cutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL Date extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map iCutoff Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL IPrimitiveType resourceType The resource type to search for Class returnType Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server. Class In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.5. API: load-page Both producer and consumer are supported The load-page API is defined in the syntax as follows: The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description byUrl Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle Load the page of results using the link with relation in the bundle Load the page of results using the link with relation prev in the bundle 31.6.5.1. Method byUrl Signatures: org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/byUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map returnType The return type Class url The search url String 31.6.5.2. Method Signatures: org.hl7.fhir.instance.model.api.IBaseBundle (org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/ API method has the parameters listed in the table below: Parameter Description Type bundle The IBaseBundle IBaseBundle extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map 31.6.5.3. Method Signatures: org.hl7.fhir.instance.model.api.IBaseBundle (org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/ API method has the parameters listed in the table below: Parameter Description Type bundle The IBaseBundle IBaseBundle extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.6. API: meta Both producer and consumer are supported The meta API is defined in the syntax as follows: The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description add Add the elements in the given metadata to the already existing set (do not remove any) delete Delete the elements in the given metadata from the given id getFromResource Fetch the current metadata from a specific resource getFromServer Fetch the current metadata from the whole Server getFromType Fetch the current metadata from a specific type 31.6.6.1. Method add Signatures: org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/add API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The id IIdType meta The IBaseMetaType class IBaseMetaType 31.6.6.2. Method delete Signatures: org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/delete API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The id IIdType meta The IBaseMetaType class IBaseMetaType 31.6.6.3. Method getFromResource Signatures: org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/getFromResource API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The id IIdType metaType The IBaseMetaType class Class 31.6.6.4. Method getFromServer Signatures: org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/getFromServer API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map metaType The type of the meta datatype for the given FHIR model version (should be MetaDt.class or MetaType.class) Class 31.6.6.5. Method getFromType Signatures: org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, String resourceType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/getFromType API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map metaType The IBaseMetaType class Class resourceType The resource type e.g Patient String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.7. API: operation Both producer and consumer are supported The operation API is defined in the syntax as follows: The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description onInstance Perform the operation across all versions of a specific resource (by ID and type) on the server onInstanceVersion This operation operates on a specific version of a resource onServer Perform the operation across all versions of all resources of all types on the server onType Perform the operation across all versions of all resources of the given type on the server processMessage This operation is called USDprocess-message as defined by the FHIR specification 31.6.7.1. Method onInstance Signatures: org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onInstance API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id Resource (version will be stripped) IIdType name Operation name String outputParameterType The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL Class parameters The parameters to use as input. May also be null if the operation does not require any input parameters. IBaseParameters returnType If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/USDeverything) which return a bundle instead of a Parameters resource, may be NULL Class useHttpGet Use HTTP GET verb Boolean 31.6.7.2. Method onInstanceVersion Signatures: org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onInstanceVersion API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id Resource version IIdType name Operation name String outputParameterType The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL Class parameters The parameters to use as input. May also be null if the operation does not require any input parameters. IBaseParameters returnType If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/USDeverything) which return a bundle instead of a Parameters resource, may be NULL Class useHttpGet Use HTTP GET verb Boolean 31.6.7.3. Method onServer Signatures: org.hl7.fhir.instance.model.api.IBaseResource onServer(String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onServer API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map name Operation name String outputParameterType The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL Class parameters The parameters to use as input. May also be null if the operation does not require any input parameters. IBaseParameters returnType If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/USDeverything) which return a bundle instead of a Parameters resource, may be NULL Class useHttpGet Use HTTP GET verb Boolean 31.6.7.4. Method onType Signatures: org.hl7.fhir.instance.model.api.IBaseResource onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/onType API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map name Operation name String outputParameterType The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using), may be NULL Class parameters The parameters to use as input. May also be null if the operation does not require any input parameters. IBaseParameters resourceType The resource type to operate on Class returnType If this operation returns a single resource body as its return type instead of a Parameters resource, use this method to specify that resource type. This is useful for certain operations (e.g. Patient/NNN/USDeverything) which return a bundle instead of a Parameters resource, may be NULL Class useHttpGet Use HTTP GET verb Boolean 31.6.7.5. Method processMessage Signatures: org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class<org.hl7.fhir.instance.model.api.IBaseBundle> responseClass, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/processMessage API method has the parameters listed in the table below: Parameter Description Type asynchronous Whether to process the message asynchronously or synchronously, defaults to synchronous. Boolean extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map msgBundle Set the Message Bundle to POST to the messaging server IBaseBundle respondToUri An optional query parameter indicating that responses from the receiving server should be sent to this URI, may be NULL String responseClass The response class Class In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.8. API: patch Both producer and consumer are supported The patch API is defined in the syntax as follows: The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description patchById Applies the patch to the given resource ID patchByUrl Specifies that the update should be performed as a conditional create against a given search URL 31.6.8.1. Method patchById Signatures: ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/patchById API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The resource ID to patch IIdType patchBody The body of the patch document serialized in either XML or JSON which conforms to String preferReturn Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() PreferReturnEnum stringId The resource ID to patch String 31.6.8.2. Method patchByUrl Signatures: ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/patchByUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map patchBody The body of the patch document serialized in either XML or JSON which conforms to String preferReturn Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() PreferReturnEnum url The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366 String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.9. API: read Both producer and consumer are supported The read API is defined in the syntax as follows: The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description resourceById Reads a IBaseResource on the server by id resourceByUrl Reads a IBaseResource on the server by url 31.6.9.1. Method resourceById Signatures: org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resourceById API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The IIdType referencing the resource IIdType ifVersionMatches A version to match against the newest version on the server String longId The resource ID Long resource The resource to read (e.g. Patient) Class resourceClass The resource to read (e.g. Patient) String returnNull Return null if version matches Boolean returnResource Return the resource if version matches IBaseResource stringId The resource ID String throwError Throw error if the version matches Boolean version The resource version String 31.6.9.2. Method resourceByUrl Signatures: org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resourceByUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map iUrl The IIdType referencing the resource by absolute url IIdType ifVersionMatches A version to match against the newest version on the server String resource The resource to read (e.g. Patient) Class resourceClass The resource to read (e.g. Patient.class) String returnNull Return null if version matches Boolean returnResource Return the resource if version matches IBaseResource throwError Throw error if the version matches Boolean url Referencing the resource by absolute url String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.10. API: search Both producer and consumer are supported The search API is defined in the syntax as follows: The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description searchByUrl Perform a search directly by URL 31.6.10.1. Method searchByUrl Signatures: org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/searchByUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map url The URL to search for. Note that this URL may be complete (e.g. ) in which case the client's base URL will be ignored. Or it can be relative (e.g. Patientname=foo) in which case the client's base URL will be used. String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.11. API: transaction Both producer and consumer are supported The transaction API is defined in the syntax as follows: The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description withBundle Use the given raw text (should be a Bundle resource) as the transaction input withResources Use a list of resources as the transaction input 31.6.11.1. Method withBundle Signatures: String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/withBundle API method has the parameters listed in the table below: Parameter Description Type bundle Bundle to use in the transaction IBaseBundle extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map stringBundle Bundle to use in the transaction String 31.6.11.2. Method withResources Signatures: java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> withResources(java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> resources, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/withResources API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map resources Resources to use in the transaction List In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.12. API: update Both producer and consumer are supported The update API is defined in the syntax as follows: The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description resource Updates a IBaseResource on the server by id resourceBySearchUrl Updates a IBaseResource on the server by search url 31.6.12.1. Method resource Signatures: ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resource API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map id The IIdType referencing the resource IIdType preferReturn Whether the server include or suppress the resource body as a part of the result PreferReturnEnum resource The resource to update (e.g. Patient) IBaseResource resourceAsString The resource body to update String stringId The ID referencing the resource String 31.6.12.2. Method resourceBySearchUrl Signatures: ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resourceBySearchUrl API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map preferReturn Whether the server include or suppress the resource body as a part of the result PreferReturnEnum resource The resource to update (e.g. Patient) IBaseResource resourceAsString The resource body to update String url Specifies that the update should be performed as a conditional create against a given search URL String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.6.13. API: validate Both producer and consumer are supported The validate API is defined in the syntax as follows: The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name) Method Description resource Validates the resource 31.6.13.1. Method resource Signatures: ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters); The fhir/resource API method has the parameters listed in the table below: Parameter Description Type extraParameters See ExtraParameters for a full list of parameters that can be passed, may be NULL Map resource The IBaseResource to validate IBaseResource resourceAsString Raw resource to validate String In addition to the parameters above, the fhir API can also use any of the Query Parameters . Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFhir.parameter . The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelFhir.myParameterNameHere header. 31.7. Spring Boot Auto-Configuration The component supports 56 options, which are listed below. Name Description Default Type camel.component.fhir.access-token OAuth access token. String camel.component.fhir.autowired-enabled 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 Boolean camel.component.fhir.bridge-error-handler 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 Boolean camel.component.fhir.client To use the custom client. The option is a ca.uhn.fhir.rest.client.api.IGenericClient type. IGenericClient camel.component.fhir.client-factory To use the custom client factory. The option is a ca.uhn.fhir.rest.client.api.IRestfulClientFactory type. IRestfulClientFactory camel.component.fhir.compress Compresses outgoing (POST/PUT) contents to the GZIP format. false Boolean camel.component.fhir.configuration To use the shared configuration. The option is a org.apache.camel.component.fhir.FhirConfiguration type. FhirConfiguration camel.component.fhir.connection-timeout How long to try and establish the initial TCP connection (in ms). 10000 Integer camel.component.fhir.defer-model-scanning 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 Boolean camel.component.fhir.enabled Whether to enable auto configuration of the fhir component. This is enabled by default. Boolean camel.component.fhir.encoding Encoding to use for all request. String camel.component.fhir.fhir-context FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. The option is a ca.uhn.fhir.context.FhirContext type. FhirContext camel.component.fhir.fhir-version The FHIR Version to use. R4 String camel.component.fhir.force-conformance-check Force conformance check. false Boolean camel.component.fhir.lazy-start-producer 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 Boolean camel.component.fhir.log Will log every requests and responses. false Boolean camel.component.fhir.password Username to use for basic authentication. String camel.component.fhir.pretty-print Pretty print all request. false Boolean camel.component.fhir.proxy-host The proxy host. String camel.component.fhir.proxy-password The proxy password. String camel.component.fhir.proxy-port The proxy port. Integer camel.component.fhir.proxy-user The proxy username. String camel.component.fhir.server-url The FHIR server base URL. String camel.component.fhir.session-cookie HTTP session cookie to add to every request. String camel.component.fhir.socket-timeout How long to block for individual read/write operations (in ms). 10000 Integer camel.component.fhir.summary Request that the server modify the response using the _summary param. String camel.component.fhir.username Username to use for basic authentication. String camel.component.fhir.validation-mode When should Camel validate the FHIR Server's conformance statement. ONCE String camel.dataformat.fhirjson.content-type-header Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON. true Boolean camel.dataformat.fhirjson.dont-encode-elements If provided, specifies the elements which should NOT be encoded. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode. Set camel.dataformat.fhirjson.dont-strip-versions-from-references-at-paths If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default). List camel.dataformat.fhirjson.enabled Whether to enable auto configuration of the fhirJson data format. This is enabled by default. Boolean camel.dataformat.fhirjson.encode-elements If provided, specifies the elements which should be encoded, to the exclusion of all others. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded. Set camel.dataformat.fhirjson.encode-elements-applies-to-child-resources-only If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle). false Boolean camel.dataformat.fhirjson.fhir-version The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4. DSTU3 String camel.dataformat.fhirjson.omit-resource-id If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID. false Boolean camel.dataformat.fhirjson.override-resource-id-with-bundle-entry-full-url If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id). false Boolean camel.dataformat.fhirjson.pretty-print Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible. false Boolean camel.dataformat.fhirjson.server-base-url Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base. String camel.dataformat.fhirjson.strip-versions-from-references If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List). false Boolean camel.dataformat.fhirjson.summary-mode If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included. false Boolean camel.dataformat.fhirjson.suppress-narratives If set to true (default is false), narratives will not be included in the encoded values. false Boolean camel.dataformat.fhirxml.content-type-header Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON. true Boolean camel.dataformat.fhirxml.dont-encode-elements If provided, specifies the elements which should NOT be encoded. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode. Set camel.dataformat.fhirxml.dont-strip-versions-from-references-at-paths If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default). List camel.dataformat.fhirxml.enabled Whether to enable auto configuration of the fhirXml data format. This is enabled by default. Boolean camel.dataformat.fhirxml.encode-elements If provided, specifies the elements which should be encoded, to the exclusion of all others. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded. Set camel.dataformat.fhirxml.encode-elements-applies-to-child-resources-only If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle). false Boolean camel.dataformat.fhirxml.fhir-version The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4. DSTU3 String camel.dataformat.fhirxml.omit-resource-id If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID. false Boolean camel.dataformat.fhirxml.override-resource-id-with-bundle-entry-full-url If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id). false Boolean camel.dataformat.fhirxml.pretty-print Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible. false Boolean camel.dataformat.fhirxml.server-base-url Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base. String camel.dataformat.fhirxml.strip-versions-from-references If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List). false Boolean camel.dataformat.fhirxml.summary-mode If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included. false Boolean camel.dataformat.fhirxml.suppress-narratives If set to true (default is false), narratives will not be included in the encoded values. false Boolean

Commands:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-fhir-starter</artifactId> </dependency>
fhir://endpoint-prefix/endpoint?[options]
fhir:apiName/methodName
fhir:apiName/methodName
fhir:capabilities/methodName?[parameters]
fhir:create/methodName?[parameters]
fhir:delete/methodName?[parameters]
fhir:history/methodName?[parameters]
fhir:load-page/methodName?[parameters]
fhir:meta/methodName?[parameters]
fhir:operation/methodName?[parameters]
fhir:patch/methodName?[parameters]
fhir:read/methodName?[parameters]
fhir:search/methodName?[parameters]
fhir:transaction/methodName?[parameters]
fhir:update/methodName?[parameters]
fhir:validate/methodName?[parameters]