0.1.0 - ci-build

SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Senaite Bundle Response

Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteBundleResponse Version: 0.1.0
Draft as of 2026-11-05 Computable Name: SenaiteBundleResponse

The transaction-response Bundle returned by the server after successfully processing a SenaiteRequestBundle. One entry is returned per entry in the request, in the same order. Each entry carries the server-assigned fullUrl and a response status.

Specimen resource body. The Specimen entry additionally carries the full, server-populated SenaiteSpecimen resource in entry.resource — the only entry in this Bundle that does. This is how a consumer learns the SENAITE-assigned internal Sample ID (identifier[senaiteId]), which is not otherwise present anywhere in the response: entry.fullUrl / entry.response.location carry only the FHIR logical id, a separate value from the Sample ID business identifier used on printed barcodes and worklists. Returning the Specimen also lets a consumer immediately confirm the clientSampleId it supplied, if any, was preserved. No other entry (ServiceRequest, Patient, Practitioner, Organization) carries a resource body; a consumer needing one of those bodies still performs a read against the id returned in that entry.

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-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 1..1 id Logical id of this artifact
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. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction-response (no extensions allowed)
Bundle.entry This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8, specimen-entry-includes-resource
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.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.entry.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen 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 Sample for analysis
Bundle.entry.response This element is included in summaries. C 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.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.entry.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.entry.response.lastModified This element is included in summaries. 1..1 instant Server's date time modified
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.id 1..1 id Logical id of this artifact
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Fixed Value: transaction-response (no extensions allowed)
Bundle.link 0..0 Links related to this Bundle
Bundle.entry C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: specimen-entry-includes-resource
Bundle.entry.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen Sample for analysis
Bundle.entry.search 0..0 Search related information
Bundle.entry.request 0..0 Additional execution information (transaction/batch/history)
Bundle.entry.response 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.response.location 0..0 The location (if the operation returns a location)
Bundle.entry.response.etag 0..0 The Etag for the resource (if relevant)
Bundle.entry.response.lastModified 1..1 instant Server's date time modified
Bundle.entry.response.outcome 0..0 OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature 0..0 Digital Signature

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 1..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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction-response (no extensions allowed)
Bundle.timestamp This element is included in summaries. C 0..1 instant When the bundle was assembled
Bundle.entry This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8, specimen-entry-includes-resource
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.entry.id 0..1 string Unique id for inter-element referencing
Bundle.entry.extension 0..* Extension Additional content defined by implementations
Bundle.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.entry.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.entry.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen 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 Sample for analysis
Bundle.entry.response This element is included in summaries. C 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.response.id 0..1 string Unique id for inter-element referencing
Bundle.entry.response.extension 0..* Extension Additional content defined by implementations
Bundle.entry.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.entry.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.entry.response.lastModified This element is included in summaries. 1..1 instant Server's date time modified
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')

This structure is derived from Bundle

Summary

Mandatory: 5 elements
Fixed: 1 element
Prohibited: 9 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 1..1 id Logical id of this artifact
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. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction-response (no extensions allowed)
Bundle.entry This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8, specimen-entry-includes-resource
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.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.entry.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen 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 Sample for analysis
Bundle.entry.response This element is included in summaries. C 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.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.entry.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.entry.response.lastModified This element is included in summaries. 1..1 instant Server's date time modified
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.id 1..1 id Logical id of this artifact
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Fixed Value: transaction-response (no extensions allowed)
Bundle.total 0..0 If search, the total number of matches
Bundle.link 0..0 Links related to this Bundle
Bundle.entry C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: specimen-entry-includes-resource
Bundle.entry.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen Sample for analysis
Bundle.entry.search 0..0 Search related information
Bundle.entry.request 0..0 Additional execution information (transaction/batch/history)
Bundle.entry.response 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.response.location 0..0 The location (if the operation returns a location)
Bundle.entry.response.etag 0..0 The Etag for the resource (if relevant)
Bundle.entry.response.lastModified 1..1 instant Server's date time modified
Bundle.entry.response.outcome 0..0 OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature 0..0 Digital Signature

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 1..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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction-response (no extensions allowed)
Bundle.timestamp This element is included in summaries. C 0..1 instant When the bundle was assembled
Bundle.entry This element is included in summaries. C 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8, specimen-entry-includes-resource
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.entry.id 0..1 string Unique id for inter-element referencing
Bundle.entry.extension 0..* Extension Additional content defined by implementations
Bundle.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.entry.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.entry.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: relative-ref
Bundle.entry.resource 0..1 SenaiteSpecimen 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 Sample for analysis
Bundle.entry.response This element is included in summaries. C 1..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.entry.response.id 0..1 string Unique id for inter-element referencing
Bundle.entry.response.extension 0..* Extension Additional content defined by implementations
Bundle.entry.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.entry.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.entry.response.lastModified This element is included in summaries. 1..1 instant Server's date time modified
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relative-ref error Bundle.entry.fullUrl fullUrl in a transaction-response must be a relative ResourceType/id reference matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
specimen-entry-includes-resource error Bundle.entry The created Specimen is the only resource body returned in the response Bundle. entry.resource SHALL be present if and only if this entry's fullUrl identifies a Specimen. resource.exists() = fullUrl.startsWith('Specimen/')

This structure is derived from Bundle

Summary

Mandatory: 5 elements
Fixed: 1 element
Prohibited: 9 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron