The profile reflects typical population of a searchset bundle, ensuring the presence of information the Data Consumer system needs to process the search results.

The profile implements FHIR searchset response guidance that allows the Data Consumer to be confident about what search parameters were used as criteria when processing the request. The Data Source system SHALL populate Bundle.link.relation with “self” and Bundle.link.url with the parameters that were actually used to process the search. For example:

"link" : [
  {
   "relation" : "self",
   "url" : "Coverage?patient=patientEHR"
  }
]

• Text Summary
• Differential Table
• Snapshot Table
• Snapshot Table (Must Support)
• All

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	Bundle	Contains a collection of resources
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
entry	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	Resource	A resource in the bundle
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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	Contains a collection of resources
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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ΣI	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
entry	SΣI	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	Resource	A resource in the bundle
search	SΣI	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

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	Contains a collection of resources
type	Σ	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	ΣI	0..1	unsignedInt	If search, the total number of matches
Slices for link	Σ	1..*	BackboneElement	Links related to this Bundle Slice: Unordered, Open by value:relation
link:self	Σ	1..*	BackboneElement	Links related to this Bundle
relation	Σ	1..1	string	Executed search Fixed Value: self
entry	ΣI	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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
resource	Σ	1..1	Resource	A resource in the bundle
search	ΣI	0..1	BackboneElement	Search related information
mode	Σ	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

This structure is derived from Bundle

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 9 elements
Fixed Value: 2 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

• The element Bundle.link is sliced based on the value of value:relation

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	Bundle	Contains a collection of resources
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
entry	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	Resource	A resource in the bundle
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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	Contains a collection of resources
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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ΣI	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
entry	SΣI	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	Resource	A resource in the bundle
search	SΣI	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