FHIR XML
Since Camel 2.21
The FHIR-XML Data Format leverages HAPI-FHIR’s XML parser to parse to/from XML format to/from a HAPI-FHIR’s IBaseResource.
FHIR XML Format Options
The FHIR XML dataformat supports the following options which are listed below.
| Name | Default | Java Type | Description |
|---|---|---|---|
|
| The version of FHIR to use. Possible values are: DSTU2, DSTU2_HL7ORG, DSTU2_1, DSTU3, R4, R5. Enum values:
| |
| To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext. | ||
|
| Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements. | |
| Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler. | ||
| Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions. | ||
| If set (FQN class names), when parsing resources the parser will try to use the given types when possible. Multiple class names can be separated by comma. | ||
| When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType. | ||
| Sets the server’s base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base. | ||
|
| If set to true (default is false) the ID of any resources being encoded will not be included in the output. | |
|
| If set to true (default is false), the values supplied to setEncodeElements will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it. | |
| If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma. | ||
| If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma. | ||
|
| If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. | |
|
| If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource’s resource id if the fullUrl is defined. | |
|
| If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included. | |
|
| If set to true (default is false), narratives will not be included in the encoded values. | |
| If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. Multiple elements can be separated by comma. | ||
|
| Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON. |
Message Body
The message body at each side of the FHIR XML data format: Marshal input and Unmarshal input are the bodies marshal and unmarshal can take, and Marshal output and Unmarshal output the body after them.
| Side | Body | Description |
|---|---|---|
Marshal input |
| A HAPI FHIR resource of the fhirVersion, such as a Patient or a Bundle. Text fails: no type converter makes a resource of it. |
Marshal output |
| The FHIR XML in the stream cache, or a byte array when stream caching is off. |
Unmarshal input |
| |
Unmarshal output |
| The HAPI FHIR resource of the model of the fhirVersion, such as an org.hl7.fhir.r4.model.Patient with R4. |
The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers are described in the Camel Catalog.
Usage
The following route parses a FHIR resource from XML and writes it as JSON. The fhirVersion must match the version of the resources (R4 is the default):
- route:
from:
uri: direct:patient
steps:
- unmarshal:
fhirXml:
fhirVersion: R4
- marshal:
fhirJson:
fhirVersion: R4
prettyPrint: true
- to:
uri: mock:result