Class Bundle

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBundle, org.hl7.fhir.instance.model.api.IBaseResource

public class Bundle extends Resource implements org.hl7.fhir.instance.model.api.IBaseBundle
A container for a collection of resources.
See Also:
Serialized Form
  • Field Details

    • identifier

      A persistent identifier for the batch that won't change as a batch is copied from server to server.
    • type

      Indicates the purpose of this bundle - how it was intended to be used.
    • total

      If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
    • entry

      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
    • signature

      protected Signature signature
      Digital Signature - base64 encoded. XML-DSIg or a JWT.
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Persistent identifier for the bundle
      Type: token
      Path: Bundle.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Persistent identifier for the bundle
      Type: token
      Path: Bundle.identifier

    • SP_COMPOSITION

      public static final String SP_COMPOSITION
      Search parameter: composition

      Description: The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to searches its contents
      Type: reference
      Path: Bundle.entry(0).resource

      See Also:
      Constant Field Values
    • COMPOSITION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSITION
      Fluent Client search parameter constant for composition

      Description: The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to searches its contents
      Type: reference
      Path: Bundle.entry(0).resource

    • INCLUDE_COMPOSITION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSITION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Bundle:composition".
    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
      Type: token
      Path: Bundle.type

      See Also:
      Constant Field Values
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
      Type: token
      Path: Bundle.type

    • SP_MESSAGE

      public static final String SP_MESSAGE
      Search parameter: message

      Description: The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents
      Type: reference
      Path: Bundle.entry(0).resource

      See Also:
      Constant Field Values
    • MESSAGE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MESSAGE
      Fluent Client search parameter constant for message

      Description: The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents
      Type: reference
      Path: Bundle.entry(0).resource

    • INCLUDE_MESSAGE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MESSAGE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Bundle:message".
  • Constructor Details

  • Method Details