http://hl7.org/fhir/StructureDefinition/Bundle|4.0.1

description: A container for a collection of resources.
derivation: specialization
name: Bundle
type: Bundle
elements:
  identifier: {short: Persistent identifier for the bundle, isSummary: true, index: 0}
  type:
    short: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/bundle-type|4.0.1'}
    isSummary: true
    index: 1
  timestamp: {short: When the bundle was assembled, isSummary: true, index: 2}
  total: {short: 'If search, the total number of matches', isSummary: true, index: 3}
  link:
    short: Links related to this Bundle
    array: true
    isSummary: true
    index: 4
    elements:
      relation: {short: 'See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1', isSummary: true, index: 5}
      url: {short: Reference details for the link, isSummary: true, index: 6}
    required: [url, relation]
  entry:
    constraint:
      bdl-8: {human: fullUrl cannot be a version specific reference, severity: error, expression: fullUrl.contains('/_history/').not()}
      bdl-5: {human: must be a resource unless there's a request or response, severity: error, expression: resource.exists() or request.exists() or response.exists()}
    short: Entry in the bundle - will have a resource or information
    array: true
    orderMeaning: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    isSummary: true
    index: 7
    elements:
      link:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/Bundle', elements, link]
        short: Links related to this entry
        array: true
        isSummary: true
        index: 8
      fullUrl: {short: URI for resource (Absolute URL server address or URI for UUID/OID), isSummary: true, index: 9}
      resource: {short: A resource in the bundle, isSummary: true, index: 10}
      search:
        short: Search related information
        isSummary: true
        index: 11
        elements:
          mode:
            short: match | include | outcome - why this is in the result set
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1'}
            isSummary: true
            index: 12
          score: {short: Search ranking (between 0 and 1), isSummary: true, index: 13}
      request:
        short: Additional execution information (transaction/batch/history)
        isSummary: true
        index: 14
        elements:
          method:
            short: GET | HEAD | POST | PUT | DELETE | PATCH
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/http-verb|4.0.1'}
            isSummary: true
            index: 15
          url: {short: URL for HTTP equivalent of this entry, isSummary: true, index: 16}
          ifNoneMatch: {short: For managing cache currency, isSummary: true, index: 17}
          ifModifiedSince: {short: For managing cache currency, isSummary: true, index: 18}
          ifMatch: {short: For managing update contention, isSummary: true, index: 19}
          ifNoneExist: {short: For conditional creates, isSummary: true, index: 20}
        required: [url, method]
      response:
        short: Results of execution (transaction/batch/history)
        isSummary: true
        index: 21
        elements:
          status: {short: Status response code (text optional), isSummary: true, index: 22}
          location: {short: The location (if the operation returns a location), isSummary: true, index: 23}
          etag: {short: The Etag for the resource (if relevant), isSummary: true, index: 24}
          lastModified: {short: Server's date time modified, isSummary: true, index: 25}
          outcome: {short: OperationOutcome with hints and warnings (for batch/transaction), isSummary: true, index: 26}
        required: [status]
  signature: {short: Digital Signature, isSummary: true, index: 27}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Bundle
base: http://hl7.org/fhir/StructureDefinition/Resource
version: 4.0.1
required: [type]