blob: 3dbe816cf1c982be06594ad10838d17824dc8bd3 [file] [log] [blame]
// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= FHIR
:page-aliases: extensions/fhir.adoc
:linkattrs:
:cq-artifact-id: camel-quarkus-fhir
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard. Marshall and unmarshall FHIR objects to/from JSON. Marshall and unmarshall FHIR objects to/from XML.
:cq-deprecated: false
:cq-jvm-since: 0.3.0
:cq-native-since: 0.3.0
[.badges]
[.badge-key]##JVM since##[.badge-supported]##0.3.0## [.badge-key]##Native since##[.badge-supported]##0.3.0##
Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard. Marshall and unmarshall FHIR objects to/from JSON. Marshall and unmarshall FHIR objects to/from XML.
== What's inside
* xref:{cq-camel-components}::fhir-component.adoc[FHIR component], URI syntax: `fhir:apiName/methodName`
* xref:{cq-camel-components}:dataformats:fhirJson-dataformat.adoc[FHIR JSon data format]
* xref:{cq-camel-components}:dataformats:fhirXml-dataformat.adoc[FHIR XML data format]
Please refer to the above links for usage and configuration details.
== Maven coordinates
https://code.quarkus.io/?extension-search=camel-quarkus-fhir[Create a new project with this extension on code.quarkus.io, window="_blank"]
Or add the coordinates to your existing project:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-fhir</artifactId>
</dependency>
----
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
== SSL in native mode
This extension auto-enables SSL support in native mode. Hence you do not need to add
`quarkus.ssl.native=true` to your `application.properties` yourself. See also
https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].
== Additional Camel Quarkus configuration
By default, only FHIR versions `R4` & `DSTU3` are enabled in native mode, since they are the default values on the FHIR component and DataFormat.
[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu2]]`link:#quarkus.camel.fhir.enable-dstu2[quarkus.camel.fhir.enable-dstu2]`
Enable FHIR DSTU2 Specs in native mode.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu2_hl7org]]`link:#quarkus.camel.fhir.enable-dstu2_hl7org[quarkus.camel.fhir.enable-dstu2_hl7org]`
Enable FHIR DSTU2_HL7ORG Specs in native mode.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu2_1]]`link:#quarkus.camel.fhir.enable-dstu2_1[quarkus.camel.fhir.enable-dstu2_1]`
Enable FHIR DSTU2_1 Specs in native mode.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu3]]`link:#quarkus.camel.fhir.enable-dstu3[quarkus.camel.fhir.enable-dstu3]`
Enable FHIR DSTU3 Specs in native mode.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-r4]]`link:#quarkus.camel.fhir.enable-r4[quarkus.camel.fhir.enable-r4]`
Enable FHIR R4 Specs in native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-r5]]`link:#quarkus.camel.fhir.enable-r5[quarkus.camel.fhir.enable-r5]`
Enable FHIR R5 Specs in native mode.
| `boolean`
| `false`
|===
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.