Package ca.uhn.fhir.parser

Interface IParser

All Known Subinterfaces:
IJsonLikeParser
All Known Implementing Classes:
BaseParser, JsonParser, NDJsonParser, RDFParser, XmlParser
public interface IParser
A parser, which can be used to convert between HAPI FHIR model/structure objects, and their respective String wire formats, in either XML or JSON.

Thread safety: Parsers are not guaranteed to be thread safe. Create a new parser instance for every thread or every message being parsed/encoded.

  • Method Details

    • encodeResourceToString

      String encodeResourceToString(IBaseResource theResource) throws DataFormatException
      Encodes a resource using the parser's given encoding format.
      Parameters:
      theResource - The resource to encode. Must not be null.
      Returns:
      A string representation of the encoding
      Throws:
      DataFormatException - If any invalid elements within the contents to be encoded prevent successful encoding.

    • encodeResourceToWriter

      void encodeResourceToWriter(IBaseResource theResource, Writer theWriter) throws IOException, DataFormatException
      Encodes a resource using the parser's given encoding format.
      Parameters:
      theResource - The resource to encode. Must not be null.
      theWriter - The writer to write to.
      Throws:
      DataFormatException - If any invalid elements within the contents to be encoded prevent successful encoding.
      IOException

    • encodeToString

      String encodeToString(IBase theElement) throws DataFormatException
      Encodes any FHIR element to a string. If a resource object is passed in, the resource will be encoded using standard FHIR encoding rules. If a primitive datatype is passed in, the string value of the primitive type is encoded. Any extensions on the primitive type are not encoded. If any other object is passed in, a fragment is encoded. The format of the fragment depends on the encoding:
      • JSON: The fragment is output as a simple JSON object, exactly as it would appear within an encoded resource.
      • XML: The fragment is output as an XML element as it would appear within an encoded resource, however it is wrapped in an element called <element> in order to avoid producing a document with multiple root tags.
      • RDF/Turtle: This mode is not supported and will throw an InternalErrorException
      Throws:
      DataFormatException
      Since:
      6.8.0

    • encodeToWriter

      void encodeToWriter(IBase theElement, Writer theWriter) throws DataFormatException, IOException
      Encodes any FHIR element to a writer. If a resource object is passed in, the resource will be encoded using standard FHIR encoding rules. If a primitive datatype is passed in, the string value of the primitive type is encoded. Any extensions on the primitive type are not encoded. If any other object is passed in, a fragment is encoded. The format of the fragment depends on the encoding:
      • JSON: The fragment is output as a simple JSON object, exactly as it would appear within an encoded resource.
      • XML: The fragment is output as an XML element as it would appear within an encoded resource, however it is wrapped in an element called <element> in order to avoid producing a document with multiple root tags.
      • RDF/Turtle: This mode is not supported and will throw an InternalErrorException
      Throws:
      DataFormatException
      IOException
      Since:
      6.8.0

    • getEncodeForceResourceId

      IIdType getEncodeForceResourceId()
      If not set to null (as is the default) this ID will be used as the ID in any resources encoded by this parser

    • setEncodeForceResourceId

      IParser setEncodeForceResourceId(IIdType theForceResourceId)
      When encoding, force this resource ID to be encoded as the resource ID

    • getEncoding

      EncodingEnum getEncoding()
      Which encoding does this parser instance produce?

    • getPreferTypes

      List<Class<? extends IBaseResource>> getPreferTypes()
      Gets the preferred types, as set using setPreferTypes(List)
      Returns:
      Returns the preferred types, or null
      See Also:

    • setPreferTypes

      void setPreferTypes(List<Class<? extends IBaseResource>> thePreferTypes)
      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.

      This feature is related to, but not the same as the FhirContext.setDefaultTypeForProfile(String, Class) feature. setDefaultTypeForProfile is used to specify a type to be used when a resource explicitly declares support for a given profile. This feature specifies a type to be used irrespective of the profile declaration in the metadata statement.

      Parameters:
      thePreferTypes - The preferred types, or null

    • isOmitResourceId

      boolean isOmitResourceId()
      Returns true if resource IDs should be omitted
      Since:
      1.1
      See Also:

    • setOmitResourceId

      IParser setOmitResourceId(boolean theOmitResourceId)
      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.

      If the resource being encoded is a Bundle or Parameters resource, this setting only applies to the outer resource being encoded, not any resources contained within.

      Parameters:
      theOmitResourceId - Should resource IDs be omitted
      Returns:
      Returns a reference to this parser so that method calls can be chained together
      Since:
      1.1

    • getStripVersionsFromReferences

      Boolean getStripVersionsFromReferences()
      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.
      Returns:
      Returns the parser instance's configuration setting for stripping versions from resource references when encoding. This method will return null if no value is set, in which case the value from the ParserOptions will be used (default is true)
      See Also:

    • setStripVersionsFromReferences

      IParser setStripVersionsFromReferences(Boolean theStripVersionsFromReferences)
      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 setDontStripVersionsFromReferencesAtPaths(String...)

      Parameters:
      theStripVersionsFromReferences - Set this to false to prevent the parser from removing resource versions from references (or null to apply the default setting from the ParserOptions
      Returns:
      Returns a reference to this parser so that method calls can be chained together
      See Also:

    • isSummaryMode

      boolean isSummaryMode()
      Is the parser in "summary mode"? See setSummaryMode(boolean) for information
      See Also:

    • setSummaryMode

      IParser setSummaryMode(boolean theSummaryMode)
      If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.

      It is possible to modify the default summary mode element inclusions for this parser instance by invoking setEncodeElements(Set) or setDontEncodeElements(Collection). It is also possible to modify the default summary mode element inclusions for all parsers generated for a given FhirContext by accessing FhirContext.getParserOptions() followed by ParserOptions.setEncodeElementsForSummaryMode(Collection) and/or ParserOptions.setDontEncodeElementsForSummaryMode(Collection).

      For compatibility reasons with other frameworks, when encoding a CapabilityStatement resource in summary mode, extensions are always encoded, even though the FHIR Specification does not consider them to be summary elements.

      Returns:
      Returns a reference to this parser so that method calls can be chained together

    • parseResource

      <T extends IBaseResource> T parseResource(Class<T> theResourceType, Reader theReader) throws DataFormatException
      Parses a resource
      Parameters:
      theResourceType - The resource type to use. This can be used to explicitly specify a class which extends a built-in type (e.g. a custom type extending the default Patient class)
      theReader - The reader to parse input from. Note that the Reader will not be closed by the parser upon completion.
      Returns:
      A parsed resource
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason

    • parseResource

      <T extends IBaseResource> T parseResource(Class<T> theResourceType, InputStream theInputStream) throws DataFormatException
      Parses a resource
      Parameters:
      theResourceType - The resource type to use. This can be used to explicitly specify a class which extends a built-in type (e.g. a custom type extending the default Patient class)
      theInputStream - The InputStream to parse input from, with an implied charset of UTF-8. Note that the InputStream will not be closed by the parser upon completion.
      Returns:
      A parsed resource
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason

    • parseResource

      <T extends IBaseResource> T parseResource(Class<T> theResourceType, String theString) throws DataFormatException
      Parses a resource
      Parameters:
      theResourceType - The resource type to use. This can be used to explicitly specify a class which extends a built-in type (e.g. a custom type extending the default Patient class)
      theString - The string to parse
      Returns:
      A parsed resource
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason

    • parseResource

      IBaseResource parseResource(Reader theReader) throws ConfigurationException, DataFormatException
      Parses a resource
      Parameters:
      theReader - The reader to parse input from. Note that the Reader will not be closed by the parser upon completion.
      Returns:
      A parsed resource. Note that the returned object will be an instance of IResource or IAnyResource depending on the specific FhirContext which created this parser.
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason
      ConfigurationException

    • parseResource

      IBaseResource parseResource(InputStream theInputStream) throws ConfigurationException, DataFormatException
      Parses a resource
      Parameters:
      theInputStream - The InputStream to parse input from (charset is assumed to be UTF-8). Note that the stream will not be closed by the parser upon completion.
      Returns:
      A parsed resource. Note that the returned object will be an instance of IResource or IAnyResource depending on the specific FhirContext which created this parser.
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason
      ConfigurationException

    • parseResource

      IBaseResource parseResource(String theMessageString) throws ConfigurationException, DataFormatException
      Parses a resource
      Parameters:
      theMessageString - The string to parse
      Returns:
      A parsed resource. Note that the returned object will be an instance of IResource or IAnyResource depending on the specific FhirContext which created this parser.
      Throws:
      DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason
      ConfigurationException

    • setDontEncodeElements

      IParser setDontEncodeElements(@Nullable Collection<String> theDontEncodeElements)
      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)

      Note: If setSummaryMode(boolean) is set to true, then any elements specified using this method will be excluded even if they are summary elements.

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

      Parameters:
      theDontEncodeElements - The elements to not encode, or null
      See Also:

    • setDontEncodeElements

      default IParser setDontEncodeElements(@Nonnull String... theDontEncodeElements)
      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 sub-elements on meta such as Patient.meta.lastUpdated will only work in DSTU3+ mode.

      Parameters:
      theDontEncodeElements - The elements to not encode. Can be an empty list, but must not be null.
      Since:
      7.4.0
      See Also:

    • setEncodeElements

      IParser setEncodeElements(@Nullable Set<String> theEncodeElements)
      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

      Note: If setSummaryMode(boolean) is set to true, then any elements specified using this method will be included even if they are not summary elements.

      Parameters:
      theEncodeElements - The elements to encode, or null
      See Also:

    • setEncodeElements

      default IParser setEncodeElements(@Nonnull String... theEncodeElements)
      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

      Note: If setSummaryMode(boolean) is set to true, then any elements specified using this method will be included even if they are not summary elements.

      Parameters:
      theEncodeElements - The elements to encode. Can be an empty list, but must not be null.
      Since:
      7.4.0
      See Also:

    • isEncodeElementsAppliesToChildResourcesOnly

      boolean isEncodeElementsAppliesToChildResourcesOnly()
      If set to true (default is false), the values supplied to 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)

    • setEncodeElementsAppliesToChildResourcesOnly

      void setEncodeElementsAppliesToChildResourcesOnly(boolean theEncodeElementsAppliesToChildResourcesOnly)
      If set to true (default is false), the values supplied to 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)

    • setParserErrorHandler

      IParser setParserErrorHandler(IParserErrorHandler theErrorHandler)
      Registers an error handler which will be invoked when any parse errors are found
      Parameters:
      theErrorHandler - The error handler to set. Must not be null.

    • setPrettyPrint

      IParser setPrettyPrint(boolean thePrettyPrint)
      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:
      thePrettyPrint - The flag
      Returns:
      Returns an instance of this parser so that method calls can be chained together

    • setServerBaseUrl

      IParser setServerBaseUrl(String theUrl)
      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:
      theUrl - The base URL, e.g. "http://example.com/base"
      Returns:
      Returns an instance of this parser so that method calls can be chained together

    • setOverrideResourceIdWithBundleEntryFullUrl

      IParser setOverrideResourceIdWithBundleEntryFullUrl(Boolean theOverrideResourceIdWithBundleEntryFullUrl)
      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:
      theOverrideResourceIdWithBundleEntryFullUrl - 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 ParserOptions)
      Returns:
      Returns a reference to this parser so that method calls can be chained together
      See Also:

    • setSuppressNarratives

      IParser setSuppressNarratives(boolean theSuppressNarratives)
      If set to true (default is false), narratives will not be included in the encoded values.

    • getDontStripVersionsFromReferencesAtPaths

      Set<String> getDontStripVersionsFromReferencesAtPaths()
      Returns the value supplied to setDontStripVersionsFromReferencesAtPaths(String...) or null if no value has been set for this parser (in which case the default from the ParserOptions will be used).
      See Also:

    • setDontStripVersionsFromReferencesAtPaths

      IParser setDontStripVersionsFromReferencesAtPaths(String... thePaths)
      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(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

      Parameters:
      thePaths - 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 ParserOptions
      Returns:
      Returns a reference to this parser so that method calls can be chained together
      See Also:

    • setDontStripVersionsFromReferencesAtPaths

      IParser setDontStripVersionsFromReferencesAtPaths(Collection<String> thePaths)
      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(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

      Parameters:
      thePaths - 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 ParserOptions
      Returns:
      Returns a reference to this parser so that method calls can be chained together
      See Also:

    • parseInto

      default void parseInto(String theSource, IBase theTarget)
      Parses an object fragment into the given structure.
      Parameters:
      theSource - The source value to parse and use to populate theTarget. If theTarget is an instance of IPrimitiveType the value is treated as a simple string value. So for example, when populating a DateTimeTime, the value should resemble 2020-01-01, not <birthDate value="2020-01-01"/>. If theTarget is a complex structure, the value should be a container element suitable for the parser's encoding. So for example, if the target is an Identifier, the value would be expected to resemble <identifier><system value="..."/><value value="..."/></identifier> or {"system":"...", "value":"..."}.
      theTarget - The target structure to populate. Note that this structure is not cleared automatically by the parser, so existing values will be overwritten only if theSource has a value for the given element.
      Since:
      8.2.0

    • parseInto

      void parseInto(Reader theSource, IBase theTarget) throws IOException
      Parses an object fragment into the given structure.
      Parameters:
      theSource - The source value to parse and use to populate theTarget. If theTarget is an instance of IPrimitiveType the value is treated as a simple string value. So for example, when populating a DateTimeTime, the value should resemble 2020-01-01, not <birthDate value="2020-01-01"/>. If theTarget is a complex structure, the value should be a container element suitable for the parser's encoding. So for example, if the target is an Identifier, the value would be expected to resemble <identifier><system value="..."/><value value="..."/></identifier> or {"system":"...", "value":"..."}.
      theTarget - The target structure to populate. Note that this structure is not cleared automatically by the parser, so existing values will be overwritten only if theSource has a value for the given element.
      Throws:
      IOException
      Since:
      8.2.0