Class FhirDataformat
- java.lang.Object
-
- org.apache.camel.model.IdentifiedType
-
- org.apache.camel.model.DataFormatDefinition
-
- org.apache.camel.model.dataformat.FhirDataformat
-
- All Implemented Interfaces:
ContentTypeHeaderAware
- Direct Known Subclasses:
FhirJsonDataFormat
,FhirXmlDataFormat
public abstract class FhirDataformat extends DataFormatDefinition implements ContentTypeHeaderAware
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FhirDataformat()
protected
FhirDataformat(String dataFormatName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getContentTypeHeader()
Whether the data format should set the Content-Type header with the type from the data format.Set<String>
getDontEncodeElements()
List<String>
getDontStripVersionsFromReferencesAtPaths()
Set<String>
getEncodeElements()
String
getEncodeElementsAppliesToChildResourcesOnly()
Object
getFhirContext()
String
getFhirVersion()
Object
getForceResourceId()
String
getOmitResourceId()
String
getOverrideResourceIdWithBundleEntryFullUrl()
Object
getParserErrorHandler()
Object
getParserOptions()
Object
getPreferTypes()
String
getPrettyPrint()
String
getServerBaseUrl()
String
getStripVersionsFromReferences()
String
getSummaryMode()
String
getSuppressNarratives()
void
setContentTypeHeader(String contentTypeHeader)
Whether the data format should set the Content-Type header with the type from the data format.void
setDontEncodeElements(Set<String> dontEncodeElements)
If provided, specifies the elements which should NOT be encoded.void
setDontStripVersionsFromReferencesAtPaths(List<String> dontStripVersionsFromReferencesAtPaths)
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.void
setEncodeElements(Set<String> encodeElements)
If provided, specifies the elements which should be encoded, to the exclusion of all others.void
setEncodeElementsAppliesToChildResourcesOnly(String encodeElementsAppliesToChildResourcesOnly)
If set totrue
(default is false), the values supplied tosetEncodeElements(Set)
will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e.void
setFhirContext(Object fhirContext)
void
setFhirVersion(String fhirVersion)
The version of FHIR to use.void
setForceResourceId(Object forceResourceId)
When encoding, force this resource ID to be encoded as the resource IDvoid
setOmitResourceId(String omitResourceId)
If set totrue
(default isfalse
) the ID of any resources being encoded will not be included in the output.void
setOverrideResourceIdWithBundleEntryFullUrl(String overrideResourceIdWithBundleEntryFullUrl)
If set totrue
(which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined.void
setParserErrorHandler(Object parserErrorHandler)
Registers an error handler which will be invoked when any parse errors are foundvoid
setParserOptions(Object parserOptions)
Sets the parser options object which will be used to supply default options to newly created parsers.void
setPreferTypes(Object preferTypes)
If set, when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority).void
setPrettyPrint(String prettyPrint)
Sets the "pretty print" flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.void
setServerBaseUrl(String serverBaseUrl)
Sets the server's base URL used by this parser.void
setStripVersionsFromReferences(String stripVersionsFromReferences)
If set totrue
(which is the default), resource references containing a version will have the version removed when the resource is encoded.
void
setSummaryMode(String summaryMode)
If set totrue
(default isfalse
) only elements marked by the FHIR specification as being "summary elements" will be included.void
setSuppressNarratives(String suppressNarratives)
If set totrue
(default isfalse
), narratives will not be included in the encoded values.-
Methods inherited from class org.apache.camel.model.DataFormatDefinition
getDataFormat, getDataFormatName, getShortName, setDataFormat, setDataFormatName
-
Methods inherited from class org.apache.camel.model.IdentifiedType
getId, setId
-
-
-
-
Constructor Detail
-
FhirDataformat
protected FhirDataformat(String dataFormatName)
-
FhirDataformat
protected FhirDataformat()
-
-
Method Detail
-
getFhirContext
public Object getFhirContext()
-
setFhirContext
public void setFhirContext(Object fhirContext)
-
getFhirVersion
public String getFhirVersion()
-
setFhirVersion
public void setFhirVersion(String fhirVersion)
The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5
-
getPrettyPrint
public String getPrettyPrint()
-
setPrettyPrint
public void setPrettyPrint(String prettyPrint)
Sets the "pretty print" flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.- Parameters:
prettyPrint
- The flag
-
getParserErrorHandler
public Object getParserErrorHandler()
-
setParserErrorHandler
public void setParserErrorHandler(Object parserErrorHandler)
Registers an error handler which will be invoked when any parse errors are found- Parameters:
parserErrorHandler
- The error handler to set. Must not be null.
-
getParserOptions
public Object getParserOptions()
-
setParserOptions
public void setParserOptions(Object parserOptions)
Sets the parser options object which will be used to supply default options to newly created parsers.- Parameters:
parserOptions
- The parser options object
-
getPreferTypes
public Object getPreferTypes()
-
setPreferTypes
public void setPreferTypes(Object preferTypes)
If set, when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type.- Parameters:
preferTypes
- The preferred types, ornull
-
getForceResourceId
public Object getForceResourceId()
-
setForceResourceId
public void setForceResourceId(Object forceResourceId)
When encoding, force this resource ID to be encoded as the resource ID
-
getServerBaseUrl
public String getServerBaseUrl()
-
setServerBaseUrl
public void setServerBaseUrl(String serverBaseUrl)
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.- Parameters:
serverBaseUrl
- The base URL, e.g. "http://example.com/base"
-
getOmitResourceId
public String getOmitResourceId()
-
setOmitResourceId
public void setOmitResourceId(String omitResourceId)
If set totrue
(default isfalse
) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set totrue
, contained resources will still have local IDs but the outer/containing ID will not have an ID.- Parameters:
omitResourceId
- Should resource IDs be omitted
-
getEncodeElementsAppliesToChildResourcesOnly
public String getEncodeElementsAppliesToChildResourcesOnly()
-
setEncodeElementsAppliesToChildResourcesOnly
public void setEncodeElementsAppliesToChildResourcesOnly(String encodeElementsAppliesToChildResourcesOnly)
If set totrue
(default is false), the values supplied tosetEncodeElements(Set)
will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)
-
setEncodeElements
public void setEncodeElements(Set<String> encodeElements)
If provided, specifies the elements which should be encoded, to the exclusion of all others. Valid values for this field would include:- Patient - Encode patient and all its children
- Patient.name - Encode only the patient's name
- Patient.name.family - Encode only the patient's family name
- *.text - Encode the text element on any resource (only the very first position may contain a wildcard)
- *.(mandatory) - This is a special case which causes any mandatory fields (min > 0) to be encoded
- Parameters:
encodeElements
- The elements to encode- See Also:
setDontEncodeElements(Set)
-
setDontEncodeElements
public void setDontEncodeElements(Set<String> dontEncodeElements)
If provided, specifies the elements which should NOT be encoded. Valid values for this field would include:- Patient - Don't encode patient and all its children
- Patient.name - Don't encode the patient's name
- Patient.name.family - Don't encode the patient's family name
- *.text - Don't encode the text element on any resource (only the very first position may contain a wildcard)
DSTU2 note: Note that values including meta, such as
Patient.meta
will work for DSTU2 parsers, but values with subelements on meta such asPatient.meta.lastUpdated
will only work in DSTU3+ mode.- Parameters:
dontEncodeElements
- The elements to encode- See Also:
setEncodeElements(Set)
-
getStripVersionsFromReferences
public String getStripVersionsFromReferences()
-
setStripVersionsFromReferences
public void setStripVersionsFromReferences(String stripVersionsFromReferences)
If set totrue
(which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to
false
.This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use
setDontStripVersionsFromReferencesAtPaths(List)
- Parameters:
stripVersionsFromReferences
- Set this tofalse
to prevent the parser from removing resource versions from references (or
null
to apply the default setting from thesetParserOptions(Object)
- See Also:
setDontStripVersionsFromReferencesAtPaths(List)
-
getOverrideResourceIdWithBundleEntryFullUrl
public String getOverrideResourceIdWithBundleEntryFullUrl()
-
setOverrideResourceIdWithBundleEntryFullUrl
public void setOverrideResourceIdWithBundleEntryFullUrl(String overrideResourceIdWithBundleEntryFullUrl)
If set totrue
(which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this tofalse
if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).- Parameters:
overrideResourceIdWithBundleEntryFullUrl
- Set this tofalse
to prevent the parser from overriding resource ids with the Bundle.entry.fullUrl (ornull
to apply the default setting from thesetParserOptions(Object)
)
-
getSummaryMode
public String getSummaryMode()
-
setSummaryMode
public void setSummaryMode(String summaryMode)
If set totrue
(default isfalse
) only elements marked by the FHIR specification as being "summary elements" will be included.
-
getSuppressNarratives
public String getSuppressNarratives()
-
setSuppressNarratives
public void setSuppressNarratives(String suppressNarratives)
If set totrue
(default isfalse
), narratives will not be included in the encoded values.
-
getDontStripVersionsFromReferencesAtPaths
public List<String> getDontStripVersionsFromReferencesAtPaths()
-
setDontStripVersionsFromReferencesAtPaths
public void setDontStripVersionsFromReferencesAtPaths(List<String> dontStripVersionsFromReferencesAtPaths)
If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process.This method provides a finer-grained level of control than
setStripVersionsFromReferences(String)
and any paths specified by this method will be encoded even ifsetStripVersionsFromReferences(String)
has been set totrue
(which is the default)- Parameters:
dontStripVersionsFromReferencesAtPaths
- A collection of paths for which the resource versions will not be removed automatically when serializing, e.g. "Patient.managingOrganization" or "AuditEvent.object.reference". Note that only resource name and field names with dots separating is allowed here (no repetition indicators, FluentPath expressions, etc.). Set tonull
to use the value set in thesetParserOptions(Object)
- See Also:
setStripVersionsFromReferences(String)
-
getContentTypeHeader
public String getContentTypeHeader()
Description copied from interface:ContentTypeHeaderAware
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 etc.- Specified by:
getContentTypeHeader
in interfaceContentTypeHeaderAware
-
setContentTypeHeader
public void setContentTypeHeader(String contentTypeHeader)
Description copied from interface:ContentTypeHeaderAware
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 etc.- Specified by:
setContentTypeHeader
in interfaceContentTypeHeaderAware
-
-