SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: OrganizationBundle ( Abstract )

A profile that provides the minimum set of information about a Bundle using for Organization messages.

Usage:

• Derived from this Resource Profile: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle... Show 3 more, LabelerCodeRequestBundle, LabelerInactivationBundle and OutOfBusinessBundle

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: 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 bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
type	SΣ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. ele-1: All FHIR elements must have a @value or children Required Pattern: message
timestamp	SΣC	1..1	instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fullUrl	SΣC	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) ele-1: All FHIR elements must have a @value or children
resource	SΣC	1..1	Resource	A resource in the bundle
issues	ΣC	0..1	OperationOutcome	Issues with the Bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|5.0.0 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Required Pattern: message
timestamp	S	1..1	instant	When the bundle was assembled
entry
fullUrl	S	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
resource	S	1..1	Resource	A resource in the bundle
search		0..0
request		0..0
response		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: 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 bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
identifier	ΣC	0..1	Identifier	Persistent identifier for the bundle
type	SΣ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. Required Pattern: message
timestamp	SΣC	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	ΣC	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	ΣC	1..1	code	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required)
url	ΣC	1..1	uri	Reference details for the link
entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	SΣC	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
resource	SΣC	1..1	Resource	A resource in the bundle
signature	Σ	0..1	Signature	Digital Signature
issues	ΣC	0..1	OperationOutcome	Issues with the Bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|5.0.0 from the FHIR Standard
Bundle.link.relation	required	LinkRelationTypes http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: 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 bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
type	SΣ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. ele-1: All FHIR elements must have a @value or children Required Pattern: message
timestamp	SΣC	1..1	instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fullUrl	SΣC	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) ele-1: All FHIR elements must have a @value or children
resource	SΣC	1..1	Resource	A resource in the bundle
issues	ΣC	0..1	OperationOutcome	Issues with the Bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|5.0.0 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Required Pattern: message
timestamp	S	1..1	instant	When the bundle was assembled
entry
fullUrl	S	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
resource	S	1..1	Resource	A resource in the bundle
search		0..0
request		0..0
response		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: 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 bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements spl-X.1.1.2: The effective time year is equal to the current year spl-2.1.3.11: There is an effective time with at least the precision of day.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
identifier	ΣC	0..1	Identifier	Persistent identifier for the bundle
type	SΣ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. Required Pattern: message
timestamp	SΣC	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	ΣC	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	ΣC	1..1	code	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required)
url	ΣC	1..1	uri	Reference details for the link
entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	SΣC	1..1	uri	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
resource	SΣC	1..1	Resource	A resource in the bundle
signature	Σ	0..1	Signature	Digital Signature
issues	ΣC	0..1	OperationOutcome	Issues with the Bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|5.0.0 from the FHIR Standard
Bundle.link.relation	required	LinkRelationTypes http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
spl-2.1.3.11	error	Bundle	There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10
spl-X.1.1.2	error	Bundle	The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4))

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron