Package org.apache.camel.model.dataformat

Class FhirJsonDataFormat.Builder

    • Constructor Summary

      Constructors 
      Constructor Description
      Builder()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      T contentTypeHeader​(boolean contentTypeHeader)  
      T contentTypeHeader​(String contentTypeHeader)  
      T dontEncodeElements​(String dontEncodeElements)
      If provided, specifies the elements which should NOT be encoded.
      T dontEncodeElements​(Set<String> dontEncodeElements)
      If provided, specifies the elements which should NOT be encoded.
      T dontStripVersionsFromReferencesAtPaths​(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.
      T dontStripVersionsFromReferencesAtPaths​(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.
      T encodeElements​(String encodeElements)
      If provided, specifies the elements which should be encoded, to the exclusion of all others.
      T encodeElements​(Set<String> encodeElements)
      If provided, specifies the elements which should be encoded, to the exclusion of all others.
      T encodeElementsAppliesToChildResourcesOnly​(boolean encodeElementsAppliesToChildResourcesOnly)
      If set to true (default is false), the values supplied to FhirDataformat.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e.
      T encodeElementsAppliesToChildResourcesOnly​(String encodeElementsAppliesToChildResourcesOnly)
      If set to true (default is false), the values supplied to FhirDataformat.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e.
      FhirJsonDataFormat end()
      Ends the build of the data format.
      T fhirContext​(String fhirContext)
      To use a custom fhir context.
      T fhirVersion​(String fhirVersion)
      The version of FHIR to use.
      T forceResourceId​(String forceResourceId)
      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
      T omitResourceId​(boolean omitResourceId)
      If set to true (default is false) the ID of any resources being encoded will not be included in the output.
      T omitResourceId​(String omitResourceId)
      If set to true (default is false) the ID of any resources being encoded will not be included in the output.
      T overrideResourceIdWithBundleEntryFullUrl​(boolean overrideResourceIdWithBundleEntryFullUrl)
      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.
      T overrideResourceIdWithBundleEntryFullUrl​(String overrideResourceIdWithBundleEntryFullUrl)
      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.
      T parserErrorHandler​(String parserErrorHandler)
      Registers an error handler which will be invoked when any parse errors are found.
      T parserOptions​(String parserOptions)
      Sets the parser options object which will be used to supply default options to newly created parsers.
      T preferTypes​(String 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).
      T prettyPrint​(boolean 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.
      T prettyPrint​(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.
      T serverBaseUrl​(String serverBaseUrl)
      Sets the server's base URL used by this parser.
      T stripVersionsFromReferences​(boolean stripVersionsFromReferences)
      If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded.
      T stripVersionsFromReferences​(String stripVersionsFromReferences)
      If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded.
      T summaryMode​(boolean summaryMode)
      If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.
      T summaryMode​(String summaryMode)
      If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.
      T suppressNarratives​(boolean suppressNarratives)
      If set to true (default is false), narratives will not be included in the encoded values.
      T suppressNarratives​(String suppressNarratives)
      If set to true (default is false), narratives will not be included in the encoded values.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • fhirContext

        public T fhirContext​(String fhirContext)
        To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext

      • fhirVersion

        public T fhirVersion​(String fhirVersion)
        The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5

      • prettyPrint

        public T prettyPrint​(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

      • prettyPrint

        public T prettyPrint​(boolean 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

      • parserErrorHandler

        public T parserErrorHandler​(String parserErrorHandler)
        Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler

      • parserOptions

        public T parserOptions​(String parserOptions)
        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

      • preferTypes

        public T preferTypes​(String 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, or null

      • forceResourceId

        public T forceResourceId​(String forceResourceId)
        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

      • serverBaseUrl

        public T serverBaseUrl​(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"

      • omitResourceId

        public T omitResourceId​(String omitResourceId)
        If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.
        Parameters:
        omitResourceId - Should resource IDs be omitted

      • omitResourceId

        public T omitResourceId​(boolean omitResourceId)
        If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.
        Parameters:
        omitResourceId - Should resource IDs be omitted

      • encodeElementsAppliesToChildResourcesOnly

        public T encodeElementsAppliesToChildResourcesOnly​(String encodeElementsAppliesToChildResourcesOnly)
        If set to true (default is false), the values supplied to FhirDataformat.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)

      • encodeElementsAppliesToChildResourcesOnly

        public T encodeElementsAppliesToChildResourcesOnly​(boolean encodeElementsAppliesToChildResourcesOnly)
        If set to true (default is false), the values supplied to FhirDataformat.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)

      • encodeElements

        public T encodeElements​(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:
        FhirDataformat.setDontEncodeElements(Set)

      • encodeElements

        public T encodeElements​(String encodeElements)
        If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. 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
        Multiple elements can be separated by comma.
        Parameters:
        encodeElements - The elements to encode (multiple elements can be separated by comma)
        See Also:
        FhirDataformat.setDontEncodeElements(Set)

      • dontEncodeElements

        public T dontEncodeElements​(Set<String> dontEncodeElements)
        If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include:
        • Patient - Don't encode patient and all its children
        • Patient.name - Don't encode the patient's name
        • Patient.name.family - Don't encode the patient's family name
        • *.text - Don't encode the text element on any resource (only the very first position may contain a wildcard)

        DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3+ mode.

        Parameters:
        dontEncodeElements - The elements to NOT encode (multiple elements can be separated by comma)
        See Also:
        FhirDataformat.setEncodeElements(Set)

      • dontEncodeElements

        public T dontEncodeElements​(String dontEncodeElements)
        If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include:
        • Patient - Don't encode patient and all its children
        • Patient.name - Don't encode the patient's name
        • Patient.name.family - Don't encode the patient's family name
        • *.text - Don't encode the text element on any resource (only the very first position may contain a wildcard)

        DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3+ mode.

        Parameters:
        dontEncodeElements - The elements to NOT encode
        See Also:
        FhirDataformat.setEncodeElements(Set)

      • stripVersionsFromReferences

        public T stripVersionsFromReferences​(String stripVersionsFromReferences)
        If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false.

        This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use FhirDataformat.setDontStripVersionsFromReferencesAtPaths(List)

        Parameters:
        stripVersionsFromReferences - Set this to false to prevent the parser from removing resource versions from references (or null to apply the default setting from the parser options.

      • stripVersionsFromReferences

        public T stripVersionsFromReferences​(boolean stripVersionsFromReferences)
        If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false.

        This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use FhirDataformat.setDontStripVersionsFromReferencesAtPaths(List)

        Parameters:
        stripVersionsFromReferences - Set this to false to prevent the parser from removing resource versions from references (or null to apply the default setting from the parser options.

      • overrideResourceIdWithBundleEntryFullUrl

        public T overrideResourceIdWithBundleEntryFullUrl​(String overrideResourceIdWithBundleEntryFullUrl)
        If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).
        Parameters:
        overrideResourceIdWithBundleEntryFullUrl - Set this to false to prevent the parser from overriding resource ids with the Bundle.entry.fullUrl (or null to apply the default setting from the parser options.

      • overrideResourceIdWithBundleEntryFullUrl

        public T overrideResourceIdWithBundleEntryFullUrl​(boolean overrideResourceIdWithBundleEntryFullUrl)
        If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).
        Parameters:
        overrideResourceIdWithBundleEntryFullUrl - Set this to false to prevent the parser from overriding resource ids with the Bundle.entry.fullUrl (or null to apply the default setting from the parser options.

      • summaryMode

        public T summaryMode​(String summaryMode)
        If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.

      • summaryMode

        public T summaryMode​(boolean summaryMode)
        If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.

      • suppressNarratives

        public T suppressNarratives​(String suppressNarratives)
        If set to true (default is false), narratives will not be included in the encoded values.

      • suppressNarratives

        public T suppressNarratives​(boolean suppressNarratives)
        If set to true (default is false), narratives will not be included in the encoded values.

      • dontStripVersionsFromReferencesAtPaths

        public T dontStripVersionsFromReferencesAtPaths​(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. Multiple elements can be separated by comma when using String parameter.

        This method provides a finer-grained level of control than FhirDataformat.setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if FhirDataformat.setStripVersionsFromReferences(String) has been set to true (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 to null to use the value set in the parser options.

      • dontStripVersionsFromReferencesAtPaths

        public T dontStripVersionsFromReferencesAtPaths​(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. Multiple elements can be separated by comma when using String parameter.

        This method provides a finer-grained level of control than FhirDataformat.setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if FhirDataformat.setStripVersionsFromReferences(String) has been set to true (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 to null to use the value set in the parser options.

      • contentTypeHeader

        public T contentTypeHeader​(String contentTypeHeader)

      • contentTypeHeader

        public T contentTypeHeader​(boolean contentTypeHeader)