Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	SΣ	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. Fixed Value: searchset
total	SΣC	0..1	unsignedInt	If search, the total number of matches
Slices for link	SΣ	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
link:self	SΣ	1..*	BackboneElement	Links related to this Bundle
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	SΣ	1..1	string	Executed search Fixed Value: self
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type: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
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:patient	SΣC	1..1	BackboneElement	Patient 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:practice	SΣ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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:query-result	SΣC	1..*	BackboneElement	Query result bundle 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed Value: searchset http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:query-result.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:query-result.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.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 : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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)
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle			Bundle
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: searchset
total	S	0..1	unsignedInt	If search, the total number of matches
Slices for link	S	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:self	S	1..*	BackboneElement	Links related to this Bundle
relation	S	1..1	string	Executed search Fixed Value: self
Slices for entry	S	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
entry:All Slices				Content/Rules for all slices
search	S	0..1	BackboneElement	Search related information
mode	S	0..1	code	match | include | outcome - why this is in the result set
request		0..0
response		0..0
entry:patient	S	1..1	BackboneElement	Patient
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
entry:query-result	S	1..*	BackboneElement	Query result bundle
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
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: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	SΣ	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. Fixed Value: searchset
timestamp	Σ	0..1	instant	When the bundle was assembled
total	SΣC	0..1	unsignedInt	If search, the total number of matches
Slices for link	SΣ	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:All Slices				Content/Rules for all slices
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	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
link:self	SΣ	1..*	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	SΣ	1..1	string	Executed search Fixed Value: self
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type: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
entry:All Slices				Content/Rules for all slices
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:patient	SΣC	1..1	BackboneElement	Patient 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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:practice	SΣ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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:query-result	SΣC	1..*	BackboneElement	Query result bundle 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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Fixed Value: searchset http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:query-result.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:query-result.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.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 : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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)
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()

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• UAPI Patient (https://fhir.developer.gene.com/StructureDefinition/uapi-patient)
• UAPI Organization (https://fhir.developer.gene.com/StructureDefinition/uapi-organization)
• UAPI Bundle - Search Result (https://fhir.developer.gene.com/StructureDefinition/uapi-bundle-search-result)

Slices

This structure defines the following Slices:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	SΣ	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. Fixed Value: searchset
total	SΣC	0..1	unsignedInt	If search, the total number of matches
Slices for link	SΣ	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
link:self	SΣ	1..*	BackboneElement	Links related to this Bundle
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	SΣ	1..1	string	Executed search Fixed Value: self
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type: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
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:patient	SΣC	1..1	BackboneElement	Patient 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:practice	SΣ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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
entry:query-result	SΣC	1..*	BackboneElement	Query result bundle 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
search	SΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	SΣ	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed Value: searchset http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:query-result.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:query-result.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.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 : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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)
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle			Bundle
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: searchset
total	S	0..1	unsignedInt	If search, the total number of matches
Slices for link	S	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:self	S	1..*	BackboneElement	Links related to this Bundle
relation	S	1..1	string	Executed search Fixed Value: self
Slices for entry	S	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
entry:All Slices				Content/Rules for all slices
search	S	0..1	BackboneElement	Search related information
mode	S	0..1	code	match | include | outcome - why this is in the result set
request		0..0
response		0..0
entry:patient	S	1..1	BackboneElement	Patient
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
entry:query-result	S	1..*	BackboneElement	Query result bundle
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
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: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	SΣ	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. Fixed Value: searchset
timestamp	Σ	0..1	instant	When the bundle was assembled
total	SΣC	0..1	unsignedInt	If search, the total number of matches
Slices for link	SΣ	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:All Slices				Content/Rules for all slices
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	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
link:self	SΣ	1..*	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	SΣ	1..1	string	Executed search Fixed Value: self
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type: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
entry:All Slices				Content/Rules for all slices
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:patient	SΣC	1..1	BackboneElement	Patient 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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:practice	SΣ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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiOrganization	A grouping of people or organizations with a common purpose
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
entry:query-result	SΣC	1..*	BackboneElement	Query result bundle 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
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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	UapiBundleSearchResult	Contains a collection of resources
search	SΣC	0..1	BackboneElement	Search related information
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
mode	SΣ	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.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Fixed Value: searchset http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:query-result.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:query-result.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.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 : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:query-result	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)
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()

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• UAPI Patient (https://fhir.developer.gene.com/StructureDefinition/uapi-patient)
• UAPI Organization (https://fhir.developer.gene.com/StructureDefinition/uapi-organization)
• UAPI Bundle - Search Result (https://fhir.developer.gene.com/StructureDefinition/uapi-bundle-search-result)

Slices

This structure defines the following Slices:

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