catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/fhir.json

{
  "component": {
    "kind": "component",
    "name": "fhir",
    "title": "FHIR",
    "description": "Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard.",
    "deprecated": false,
    "firstVersion": "2.23.0",
    "label": "api",
    "javaType": "org.apache.camel.component.fhir.FhirComponent",
    "supportLevel": "Stable",
    "groupId": "org.apache.camel.springboot",
    "artifactId": "camel-fhir-starter",
    "version": "3.11.1-SNAPSHOT",
    "scheme": "fhir",
    "extendsScheme": "",
    "syntax": "fhir:apiName\/methodName",
    "async": false,
    "api": true,
    "apiSyntax": "apiName\/methodName",
    "consumerOnly": false,
    "producerOnly": false,
    "lenientProperties": false
  },
  "componentProperties": {
    "encoding": { "kind": "property", "displayName": "Encoding", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "JSON", "XML" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Encoding to use for all request" },
    "fhirVersion": { "kind": "property", "displayName": "Fhir Version", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "DSTU2", "DSTU2_HL7ORG", "DSTU2_1", "DSTU3", "R4", "R5" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "R4", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The FHIR Version to use" },
    "log": { "kind": "property", "displayName": "Log", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Will log every requests and responses" },
    "prettyPrint": { "kind": "property", "displayName": "Pretty Print", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Pretty print all request" },
    "serverUrl": { "kind": "property", "displayName": "Server Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The FHIR server base URL" },
    "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
    "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
    "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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." },
    "client": { "kind": "property", "displayName": "Client", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.client.api.IGenericClient", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "To use the custom client" },
    "clientFactory": { "kind": "property", "displayName": "Client Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.client.api.IRestfulClientFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "To use the custom client factory" },
    "compress": { "kind": "property", "displayName": "Compress", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Compresses outgoing (POST\/PUT) contents to the GZIP format" },
    "configuration": { "kind": "property", "displayName": "Configuration", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.fhir.FhirConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "To use the shared configuration" },
    "connectionTimeout": { "kind": "property", "displayName": "Connection Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "How long to try and establish the initial TCP connection (in ms)" },
    "deferModelScanning": { "kind": "property", "displayName": "Defer Model Scanning", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "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": { "kind": "property", "displayName": "Fhir Context", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.context.FhirContext", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly." },
    "forceConformanceCheck": { "kind": "property", "displayName": "Force Conformance Check", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Force conformance check" },
    "sessionCookie": { "kind": "property", "displayName": "Session Cookie", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "HTTP session cookie to add to every request" },
    "socketTimeout": { "kind": "property", "displayName": "Socket Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "How long to block for individual read\/write operations (in ms)" },
    "summary": { "kind": "property", "displayName": "Summary", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "COUNT", "TEXT", "DATA", "TRUE", "FALSE" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Request that the server modify the response using the _summary param" },
    "validationMode": { "kind": "property", "displayName": "Validation Mode", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "NEVER", "ONCE" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "ONCE", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "When should Camel validate the FHIR Server's conformance statement" },
    "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy host" },
    "proxyPassword": { "kind": "property", "displayName": "Proxy Password", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy password" },
    "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy port" },
    "proxyUser": { "kind": "property", "displayName": "Proxy User", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy username" },
    "accessToken": { "kind": "property", "displayName": "Access Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "OAuth access token" },
    "password": { "kind": "property", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" },
    "username": { "kind": "property", "displayName": "Username", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" }
  },
  "properties": {
    "apiName": { "kind": "path", "displayName": "Api Name", "group": "common", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.fhir.internal.FhirApiName", "enum": [ "CAPABILITIES", "CREATE", "DELETE", "HISTORY", "LOAD_PAGE", "META", "OPERATION", "PATCH", "READ", "SEARCH", "TRANSACTION", "UPDATE", "VALIDATE" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "What kind of operation to perform" },
    "methodName": { "kind": "path", "displayName": "Method Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "What sub operation to use for the selected operation" },
    "encoding": { "kind": "parameter", "displayName": "Encoding", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "JSON", "XML" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Encoding to use for all request" },
    "fhirVersion": { "kind": "parameter", "displayName": "Fhir Version", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "DSTU2", "DSTU2_HL7ORG", "DSTU2_1", "DSTU3", "R4", "R5" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "R4", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The FHIR Version to use" },
    "inBody": { "kind": "parameter", "displayName": "In Body", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of a parameter to be passed in the exchange In Body" },
    "log": { "kind": "parameter", "displayName": "Log", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Will log every requests and responses" },
    "prettyPrint": { "kind": "parameter", "displayName": "Pretty Print", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Pretty print all request" },
    "serverUrl": { "kind": "parameter", "displayName": "Server Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The FHIR server base URL" },
    "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
    "sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
    "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "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": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
    "pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "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": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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": { "kind": "parameter", "displayName": "Client", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.client.api.IGenericClient", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "To use the custom client" },
    "clientFactory": { "kind": "parameter", "displayName": "Client Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.client.api.IRestfulClientFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "To use the custom client factory" },
    "compress": { "kind": "parameter", "displayName": "Compress", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Compresses outgoing (POST\/PUT) contents to the GZIP format" },
    "connectionTimeout": { "kind": "parameter", "displayName": "Connection Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "How long to try and establish the initial TCP connection (in ms)" },
    "deferModelScanning": { "kind": "parameter", "displayName": "Defer Model Scanning", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "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": { "kind": "parameter", "displayName": "Fhir Context", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "ca.uhn.fhir.context.FhirContext", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly." },
    "forceConformanceCheck": { "kind": "parameter", "displayName": "Force Conformance Check", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Force conformance check" },
    "sessionCookie": { "kind": "parameter", "displayName": "Session Cookie", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "HTTP session cookie to add to every request" },
    "socketTimeout": { "kind": "parameter", "displayName": "Socket Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "How long to block for individual read\/write operations (in ms)" },
    "summary": { "kind": "parameter", "displayName": "Summary", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "COUNT", "TEXT", "DATA", "TRUE", "FALSE" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Request that the server modify the response using the _summary param" },
    "validationMode": { "kind": "parameter", "displayName": "Validation Mode", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "NEVER", "ONCE" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "ONCE", "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "When should Camel validate the FHIR Server's conformance statement" },
    "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy host" },
    "proxyPassword": { "kind": "parameter", "displayName": "Proxy Password", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy password" },
    "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy port" },
    "proxyUser": { "kind": "parameter", "displayName": "Proxy User", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "The proxy username" },
    "backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
    "backoffIdleThreshold": { "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
    "backoffMultiplier": { "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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": { "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
    "greedy": { "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
    "initialDelay": { "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
    "repeatCount": { "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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": { "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level for that." },
    "scheduledExecutorService": { "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "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": { "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
    "schedulerProperties": { "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
    "startScheduler": { "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
    "timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
    "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
    "accessToken": { "kind": "parameter", "displayName": "Access Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "OAuth access token" },
    "password": { "kind": "parameter", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" },
    "username": { "kind": "parameter", "displayName": "Username", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" }
  },
  "apis": {
    "capabilities": { "consumerOnly": false, "producerOnly": false, "description": "API to Fetch the capability statement for the server", "methods": { "ofType": { "description": "Retrieve the conformance statement using the given model type", "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)" ] } } },
    "create": { "consumerOnly": false, "producerOnly": false, "description": "API for the create operation, which creates a new resource instance on the server", "methods": { "resource": { "description": "Creates a IBaseResource on the server", "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)" ] } } },
    "delete": { "consumerOnly": false, "producerOnly": false, "description": "API for the delete operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Deletes the given 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)" ] }, "resourceById": { "description": "Deletes the resource by resource type e", "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)" ] }, "resourceConditionalByUrl": { "description": "Specifies that the delete should be performed as a conditional delete against a given search URL", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceConditionalByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } },
    "history": { "consumerOnly": false, "producerOnly": false, "description": "API for the history method", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "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)" ] }, "onServer": { "description": "Perform the operation across all versions of all resources of all types on the server", "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)" ] }, "onType": { "description": "Perform the operation across all versions of all resources of the given type on the server", "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)" ] } } },
    "load-page": { "consumerOnly": false, "producerOnly": false, "description": "API that Loads the previous\/next bundle of resources from a paged set, using the link specified in the link type=next tag within the atom bundle", "methods": { "byUrl": { "description": "Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle", "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)" ] }, "next": { "description": "Load the next page of results using the link with relation next in the bundle", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] }, "previous": { "description": "Load the previous page of results using the link with relation prev in the bundle", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } },
    "meta": { "consumerOnly": false, "producerOnly": false, "description": "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", "methods": { "add": { "description": "Add the elements in the given metadata to the already existing set (do not remove any)", "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)" ] }, "delete": { "description": "Delete the elements in the given metadata from the given id", "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)" ] }, "getFromResource": { "description": "Fetch the current metadata from a specific resource", "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)" ] }, "getFromServer": { "description": "Fetch the current metadata from the whole Server", "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)" ] }, "getFromType": { "description": "Fetch the current metadata from a specific type", "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)" ] } } },
    "operation": { "consumerOnly": false, "producerOnly": false, "description": "API for extended FHIR operations https:\/\/www", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "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)" ] }, "onInstanceVersion": { "description": "This operation operates on a specific version of a resource", "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)" ] }, "onServer": { "description": "Perform the operation across all versions of all resources of all types on the server", "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)" ] }, "onType": { "description": "Perform the operation across all versions of all resources of the given type on the server", "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)" ] }, "processMessage": { "description": "This operation is called $process-message as defined by the FHIR specification", "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)" ] } } },
    "patch": { "consumerOnly": false, "producerOnly": false, "description": "API for the patch operation, which performs a logical patch on a server resource", "methods": { "patchById": { "description": "Applies the patch to the given resource ID", "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)" ] }, "patchByUrl": { "description": "Specifies that the update should be performed as a conditional create against a given search URL", "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)" ] } } },
    "read": { "consumerOnly": false, "producerOnly": false, "description": "API method for read operations", "methods": { "resourceById": { "description": "", "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)" ] }, "resourceByUrl": { "description": "", "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)" ] } } },
    "search": { "consumerOnly": false, "producerOnly": false, "description": "API to search for resources matching a given set of criteria", "methods": { "searchByUrl": { "description": "Perform a search directly by URL", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } },
    "transaction": { "consumerOnly": false, "producerOnly": false, "description": "API for sending a transaction (collection of resources) to the server to be executed as a single unit", "methods": { "withBundle": { "description": "Use the given raw text (should be a Bundle resource) as the transaction input", "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)" ] }, "withResources": { "description": "Use a list of resources as the transaction input", "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)" ] } } },
    "update": { "consumerOnly": false, "producerOnly": false, "description": "API for the update operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "", "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)" ] }, "resourceBySearchUrl": { "description": "", "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)" ] } } },
    "validate": { "consumerOnly": false, "producerOnly": false, "description": "API for validating resources", "methods": { "resource": { "description": "", "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)" ] } } }
  },
  "apiProperties": {
    "capabilities": { "methods": { "ofType": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "type": { "kind": "parameter", "displayName": "Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseConformance>", "deprecated": false, "autowired": false, "secret": false, "description": "The model type", "optional": false } } } } },
    "create": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "preferReturn": { "kind": "parameter", "displayName": "Prefer Return", "group": "common", "label": "", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.api.PreferReturnEnum", "enum": [ "REPRESENTATION", "MINIMAL", "OPERATION_OUTCOME" ], "deprecated": false, "autowired": false, "secret": false, "description": "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", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "The resource to create", "optional": false }, "resourceAsString": { "kind": "parameter", "displayName": "Resource As String", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The resource to create", "optional": false }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&amp;identifier=13.2.4.11.4%7C847366, may be null", "optional": true } } } } },
    "delete": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseResource to delete", "optional": false } } }, "resourceById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The IIdType referencing the resource", "optional": false }, "stringId": { "kind": "parameter", "displayName": "String Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "It's id", "optional": false }, "type": { "kind": "parameter", "displayName": "Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The resource type e.g Patient", "optional": false } } }, "resourceConditionalByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&amp;identifier=13.2.4.11.4%7C847366", "optional": false } } } } },
    "history": { "methods": { "onInstance": { "properties": { "count": { "kind": "parameter", "displayName": "Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only up to theCount number of resources, may be NULL", "optional": true }, "cutoff": { "kind": "parameter", "displayName": "Cutoff", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "iCutoff": { "kind": "parameter", "displayName": "ICutoff", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date>", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The IIdType which must be populated with both a resource type and a resource ID at", "optional": false }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseBundle>", "deprecated": false, "autowired": false, "secret": false, "description": "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.", "optional": false } } }, "onServer": { "properties": { "count": { "kind": "parameter", "displayName": "Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only up to theCount number of resources, may be NULL", "optional": true }, "cutoff": { "kind": "parameter", "displayName": "Cutoff", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "iCutoff": { "kind": "parameter", "displayName": "ICutoff", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date>", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseBundle>", "deprecated": false, "autowired": false, "secret": false, "description": "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.", "optional": false } } }, "onType": { "properties": { "count": { "kind": "parameter", "displayName": "Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only up to theCount number of resources, may be NULL", "optional": true }, "cutoff": { "kind": "parameter", "displayName": "Cutoff", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "iCutoff": { "kind": "parameter", "displayName": "ICutoff", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date>", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL", "optional": true }, "resourceType": { "kind": "parameter", "displayName": "Resource Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "The resource type to search for", "optional": false }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseBundle>", "deprecated": false, "autowired": false, "secret": false, "description": "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.", "optional": false } } } } },
    "load-page": { "methods": { "byUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseBundle>", "deprecated": false, "autowired": false, "secret": false, "description": "The return type", "optional": false }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The search url", "optional": false } } }, "next": { "properties": { "bundle": { "kind": "parameter", "displayName": "Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseBundle", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true } } }, "previous": { "properties": { "bundle": { "kind": "parameter", "displayName": "Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseBundle", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true } } } } },
    "meta": { "methods": { "add": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The id", "optional": false }, "meta": { "kind": "parameter", "displayName": "Meta", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseMetaType", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseMetaType class", "optional": false } } }, "delete": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The id", "optional": false }, "meta": { "kind": "parameter", "displayName": "Meta", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseMetaType", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseMetaType class", "optional": false } } }, "getFromResource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The id", "optional": false }, "metaType": { "kind": "parameter", "displayName": "Meta Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseMetaType>", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseMetaType class", "optional": false } } }, "getFromServer": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "metaType": { "kind": "parameter", "displayName": "Meta Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseMetaType>", "deprecated": false, "autowired": false, "secret": false, "description": "The type of the meta datatype for the given FHIR model version (should be MetaDt.class or MetaType.class)", "optional": false } } }, "getFromType": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "metaType": { "kind": "parameter", "displayName": "Meta Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseMetaType>", "deprecated": false, "autowired": false, "secret": false, "description": "The IBaseMetaType class", "optional": false }, "resourceType": { "kind": "parameter", "displayName": "Resource Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The resource type e.g Patient", "optional": false } } } } },
    "operation": { "methods": { "onInstance": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "Resource (version will be stripped)", "optional": false }, "name": { "kind": "parameter", "displayName": "Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Operation name", "optional": false }, "outputParameterType": { "kind": "parameter", "displayName": "Output Parameter Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseParameters>", "deprecated": false, "autowired": false, "secret": false, "description": "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", "optional": true }, "parameters": { "kind": "parameter", "displayName": "Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseParameters", "deprecated": false, "autowired": false, "secret": false, "description": "The parameters to use as input. May also be null if the operation does not require any input parameters.", "optional": true }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "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\/$everything) which return a bundle instead of a Parameters resource, may be NULL", "optional": true }, "useHttpGet": { "kind": "parameter", "displayName": "Use Http Get", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Use HTTP GET verb", "optional": false } } }, "onInstanceVersion": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "Resource version", "optional": false }, "name": { "kind": "parameter", "displayName": "Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Operation name", "optional": false }, "outputParameterType": { "kind": "parameter", "displayName": "Output Parameter Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseParameters>", "deprecated": false, "autowired": false, "secret": false, "description": "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", "optional": true }, "parameters": { "kind": "parameter", "displayName": "Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseParameters", "deprecated": false, "autowired": false, "secret": false, "description": "The parameters to use as input. May also be null if the operation does not require any input parameters.", "optional": true }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "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\/$everything) which return a bundle instead of a Parameters resource, may be NULL", "optional": true }, "useHttpGet": { "kind": "parameter", "displayName": "Use Http Get", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Use HTTP GET verb", "optional": false } } }, "onServer": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "name": { "kind": "parameter", "displayName": "Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Operation name", "optional": false }, "outputParameterType": { "kind": "parameter", "displayName": "Output Parameter Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseParameters>", "deprecated": false, "autowired": false, "secret": false, "description": "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", "optional": true }, "parameters": { "kind": "parameter", "displayName": "Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseParameters", "deprecated": false, "autowired": false, "secret": false, "description": "The parameters to use as input. May also be null if the operation does not require any input parameters.", "optional": true }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "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\/$everything) which return a bundle instead of a Parameters resource, may be NULL", "optional": true }, "useHttpGet": { "kind": "parameter", "displayName": "Use Http Get", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Use HTTP GET verb", "optional": false } } }, "onType": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "name": { "kind": "parameter", "displayName": "Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Operation name", "optional": false }, "outputParameterType": { "kind": "parameter", "displayName": "Output Parameter Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseParameters>", "deprecated": false, "autowired": false, "secret": false, "description": "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", "optional": true }, "parameters": { "kind": "parameter", "displayName": "Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseParameters", "deprecated": false, "autowired": false, "secret": false, "description": "The parameters to use as input. May also be null if the operation does not require any input parameters.", "optional": true }, "resourceType": { "kind": "parameter", "displayName": "Resource Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "The resource type to operate on", "optional": false }, "returnType": { "kind": "parameter", "displayName": "Return Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "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\/$everything) which return a bundle instead of a Parameters resource, may be NULL", "optional": true }, "useHttpGet": { "kind": "parameter", "displayName": "Use Http Get", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Use HTTP GET verb", "optional": false } } }, "processMessage": { "properties": { "asynchronous": { "kind": "parameter", "displayName": "Asynchronous", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Whether to process the message asynchronously or synchronously, defaults to synchronous.", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "msgBundle": { "kind": "parameter", "displayName": "Msg Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "Set the Message Bundle to POST to the messaging server", "optional": false }, "respondToUri": { "kind": "parameter", "displayName": "Respond To Uri", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "An optional query parameter indicating that responses from the receiving server should be sent to this URI, may be NULL", "optional": true }, "responseClass": { "kind": "parameter", "displayName": "Response Class", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseBundle>", "deprecated": false, "autowired": false, "secret": false, "description": "The response class", "optional": false } } } } },
    "patch": { "methods": { "patchById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "The resource ID to patch", "optional": false }, "patchBody": { "kind": "parameter", "displayName": "Patch Body", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The body of the patch document serialized in either XML or JSON which conforms to http:\/\/jsonpatch.com\/ or http:\/\/tools.ietf.org\/html\/rfc5261", "optional": false }, "preferReturn": { "kind": "parameter", "displayName": "Prefer Return", "group": "common", "label": "", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.api.PreferReturnEnum", "enum": [ "REPRESENTATION", "MINIMAL", "OPERATION_OUTCOME" ], "deprecated": false, "autowired": false, "secret": false, "description": "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()", "optional": true }, "stringId": { "kind": "parameter", "displayName": "String Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The resource ID to patch", "optional": false } } }, "patchByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "patchBody": { "kind": "parameter", "displayName": "Patch Body", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The body of the patch document serialized in either XML or JSON which conforms to http:\/\/jsonpatch.com\/ or http:\/\/tools.ietf.org\/html\/rfc5261", "optional": false }, "preferReturn": { "kind": "parameter", "displayName": "Prefer Return", "group": "common", "label": "", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.api.PreferReturnEnum", "enum": [ "REPRESENTATION", "MINIMAL", "OPERATION_OUTCOME" ], "deprecated": false, "autowired": false, "secret": false, "description": "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()", "optional": true }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&amp;identifier=13.2.4.11.4%7C847366", "optional": false } } } } },
    "read": { "methods": { "resourceById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "ifVersionMatches": { "kind": "parameter", "displayName": "If Version Matches", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "longId": { "kind": "parameter", "displayName": "Long Id", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resourceClass": { "kind": "parameter", "displayName": "Resource Class", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "returnNull": { "kind": "parameter", "displayName": "Return Null", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "returnResource": { "kind": "parameter", "displayName": "Return Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "stringId": { "kind": "parameter", "displayName": "String Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "throwError": { "kind": "parameter", "displayName": "Throw Error", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "version": { "kind": "parameter", "displayName": "Version", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true } } }, "resourceByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "iUrl": { "kind": "parameter", "displayName": "IUrl", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "ifVersionMatches": { "kind": "parameter", "displayName": "If Version Matches", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.Class<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resourceClass": { "kind": "parameter", "displayName": "Resource Class", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "returnNull": { "kind": "parameter", "displayName": "Return Null", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "returnResource": { "kind": "parameter", "displayName": "Return Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "throwError": { "kind": "parameter", "displayName": "Throw Error", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false } } } } },
    "search": { "methods": { "searchByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The URL to search for. Note that this URL may be complete (e.g. http:\/\/example.com\/base\/Patientname=foo) 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.", "optional": false } } } } },
    "transaction": { "methods": { "withBundle": { "properties": { "bundle": { "kind": "parameter", "displayName": "Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "Bundle to use in the transaction", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "stringBundle": { "kind": "parameter", "displayName": "String Bundle", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Bundle to use in the transaction", "optional": false } } }, "withResources": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "resources": { "kind": "parameter", "displayName": "Resources", "group": "common", "label": "", "required": false, "type": "array", "javaType": "java.util.List<org.hl7.fhir.instance.model.api.IBaseResource>", "deprecated": false, "autowired": false, "secret": false, "description": "Resources to use in the transaction", "optional": false } } } } },
    "update": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IIdType", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "preferReturn": { "kind": "parameter", "displayName": "Prefer Return", "group": "common", "label": "", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.api.PreferReturnEnum", "enum": [ "REPRESENTATION", "MINIMAL", "OPERATION_OUTCOME" ], "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resourceAsString": { "kind": "parameter", "displayName": "Resource As String", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "stringId": { "kind": "parameter", "displayName": "String Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true } } }, "resourceBySearchUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "preferReturn": { "kind": "parameter", "displayName": "Prefer Return", "group": "common", "label": "", "required": false, "type": "object", "javaType": "ca.uhn.fhir.rest.api.PreferReturnEnum", "enum": [ "REPRESENTATION", "MINIMAL", "OPERATION_OUTCOME" ], "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resourceAsString": { "kind": "parameter", "displayName": "Resource As String", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "url": { "kind": "parameter", "displayName": "Url", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false } } } } },
    "validate": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseResource", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false }, "resourceAsString": { "kind": "parameter", "displayName": "Resource As String", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": false } } } } }
  }
}