HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft New Zealand flag

HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SA Response Bundle

Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-response-bundle Version: 0.1.1
Draft as of 2026-10-16 Computable Name: SAResponseBundle

The response to POST [base]/Claim/$submit. A collection Bundle containing the SA Application ClaimResponse, the OperationOutcome rendering the single outcome, and the resources the ClaimResponse references.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant When the bundle was assembled
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. This element is included in summaries. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. This element is included in summaries. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:operationOutcome This element must be supported. This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:operationOutcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about the success/failure of an action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. 0..1 instant When the bundle was assembled
Bundle.Slices for entry This element must be supported. 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:claimResponse This element must be supported. 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:operationOutcome This element must be supported. 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Information about the success/failure of an action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant When the bundle was assembled
Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
Bundle.link.id 0..1 string Unique id for inter-element referencing
Bundle.link.extension 0..* Extension Additional content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. This element is included in summaries. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. This element is included in summaries. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:claimResponse.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:claimResponse.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:claimResponse.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:claimResponse.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:claimResponse.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:claimResponse.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:claimResponse.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:claimResponse.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:claimResponse.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:claimResponse.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:claimResponse.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:claimResponse.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:claimResponse.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:claimResponse.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:claimResponse.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:operationOutcome This element must be supported. This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:operationOutcome.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:operationOutcome.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about the success/failure of an action
Bundle.Slices for entry.entry:operationOutcome.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:operationOutcome.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:operationOutcome.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:operationOutcome.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:operationOutcome.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:operationOutcome.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:operationOutcome.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:operationOutcome.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:operationOutcome.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:operationOutcome.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:operationOutcome.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:operationOutcome.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:operationOutcome.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:operationOutcome.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:operationOutcome.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:operationOutcome.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:operationOutcome.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:operationOutcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Bundle

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant When the bundle was assembled
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. This element is included in summaries. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. This element is included in summaries. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:operationOutcome This element must be supported. This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:operationOutcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about the success/failure of an action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. 0..1 instant When the bundle was assembled
Bundle.Slices for entry This element must be supported. 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:claimResponse This element must be supported. 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:operationOutcome This element must be supported. 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Information about the success/failure of an action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: collection (extensions allowed)
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant When the bundle was assembled
Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
Bundle.link.id 0..1 string Unique id for inter-element referencing
Bundle.link.extension 0..* Extension Additional content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element must be supported. This element is included in summaries. 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource This element must be supported. This element is included in summaries. 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:claimResponse.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:claimResponse.resource 0..1 SAApplicationClaimResponse Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:claimResponse.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:claimResponse.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:claimResponse.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:claimResponse.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:claimResponse.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:claimResponse.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:claimResponse.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:claimResponse.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:claimResponse.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:claimResponse.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:claimResponse.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:claimResponse.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:claimResponse.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:claimResponse.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:operationOutcome This element must be supported. This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: 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
Bundle.Slices for entry.entry:operationOutcome.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:operationOutcome.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:operationOutcome.resource 0..1 SAOutcomeOperationOutcome Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about the success/failure of an action
Bundle.Slices for entry.entry:operationOutcome.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:operationOutcome.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.search.mode This element is included in summaries. 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:operationOutcome.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:operationOutcome.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:operationOutcome.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:operationOutcome.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:operationOutcome.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
Bundle.Slices for entry.entry:operationOutcome.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:operationOutcome.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:operationOutcome.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:operationOutcome.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:operationOutcome.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:operationOutcome.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:operationOutcome.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:operationOutcome.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:operationOutcome.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:operationOutcome.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:operationOutcome.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:operationOutcome.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:operationOutcome.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:operationOutcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Bundle

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron