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

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