This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot: DSTU 4 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples

Resource Profile: CH MHD Provide Document Bundle Comprehensive

IHE MHD profile on Provide Document Bundle (ITI-65) transaction with Comprehensive Metadata for the Swiss EPR.

Usage:

• Examples for this Resource Profile: Bundle/2-7-BundleProvideDocument

Formal Views of Profile Content

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

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

This structure is derived from ComprehensiveProvideDocumentBundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive
meta		1..1	Meta	Metadata about the resource
Slices for profile	S	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	S	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
entry		3..*	BackboneElement	Entry in the bundle - will have a resource or information
Slices for entry				Content/Rules for all slices
entry:SubmissionSet	S	1..1	BackboneElement	the SubmissionSet
resource	S	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:DocumentRefs	S	1..*	BackboneElement	the DocumentReference resources
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:Documents	S	1..*	BackboneElement	the Documents
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:Folders		0..0
entry:Patient		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
meta	Σ	1..1	Meta	Metadata about the resource
Slices for profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	SΣ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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. Required Pattern: transaction
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	SΣ	0..1	Resource	A resource in the bundle
entry:SubmissionSet	SΣC	1..1	BackboneElement	the SubmissionSet 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	SC	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:DocumentRefs	SΣC	1..*	BackboneElement	the DocumentReference resources 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:UpdateDocumentRefs	ΣC	0..*	BackboneElement	the superseded DocumentReference resources 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	PatchParameters	Operation Request or Response
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: PATCH
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:Documents	SΣC	1..*	BackboneElement	the Documents 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:FhirDocuments	ΣC	0..*	BackboneElement	the FHIR-FhirDocuments 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	Bundle	Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: transaction http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.request.method	required	Pattern: PATCH http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Documents.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Folders.request.method	required	MHDprovideFolderActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovideFolderActions

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle, Bundle.entry:FhirDocuments.resource	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle, Bundle.entry:FhirDocuments.resource	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle, Bundle.entry:FhirDocuments.resource	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle, Bundle.entry:FhirDocuments.resource	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	A resource should have narrative for robust management : text.`div`.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()
lst-1	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	SΣ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
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. Required Pattern: transaction
timestamp	Σ	0..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	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	Σ	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
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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
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	SΣ	0..1	Resource	A resource in the bundle
search	Σ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	Σ	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)
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:SubmissionSet	SΣC	1..1	BackboneElement	the SubmissionSet 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SC	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:DocumentRefs	SΣC	1..*	BackboneElement	the DocumentReference resources 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:UpdateDocumentRefs	ΣC	0..*	BackboneElement	the superseded DocumentReference resources 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	PatchParameters	Operation Request or Response
search	Σ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	Σ	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)
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: PATCH
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:Documents	SΣC	1..*	BackboneElement	the Documents 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:FhirDocuments	ΣC	0..*	BackboneElement	the FHIR-FhirDocuments 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	C	1..1	Bundle	Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
search	Σ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	Σ	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)
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Bundle.type	required	Pattern: transaction http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.request.method	required	Pattern: PATCH http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Documents.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Documents.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Folders.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Folders.request.method	required	MHDprovideFolderActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovideFolderActions
Bundle.entry:Patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Patient.request.method	required	MHDprovidePatientActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovidePatientActions

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle, Bundle.entry:FhirDocuments.resource	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle, Bundle.entry:FhirDocuments.resource	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle, Bundle.entry:FhirDocuments.resource	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle, Bundle.entry:FhirDocuments.resource	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	A resource should have narrative for robust management : text.`div`.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()
lst-1	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from ComprehensiveProvideDocumentBundle

Summary

Mandatory: 10 elements
Must-Support: 14 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• CH MHD SubmissionSet Comprehensive (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive)
• CH MHD DocumentReference Comprehensive (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive)

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from ComprehensiveProvideDocumentBundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive
meta		1..1	Meta	Metadata about the resource
Slices for profile	S	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	S	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
entry		3..*	BackboneElement	Entry in the bundle - will have a resource or information
Slices for entry				Content/Rules for all slices
entry:SubmissionSet	S	1..1	BackboneElement	the SubmissionSet
resource	S	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:DocumentRefs	S	1..*	BackboneElement	the DocumentReference resources
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:Documents	S	1..*	BackboneElement	the Documents
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
request	S	1..1	BackboneElement	Additional execution information (transaction/batch/history)
method	S	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST
entry:Folders		0..0
entry:Patient		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
meta	Σ	1..1	Meta	Metadata about the resource
Slices for profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	SΣ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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. Required Pattern: transaction
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	SΣ	0..1	Resource	A resource in the bundle
entry:SubmissionSet	SΣC	1..1	BackboneElement	the SubmissionSet 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	SC	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:DocumentRefs	SΣC	1..*	BackboneElement	the DocumentReference resources 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:UpdateDocumentRefs	ΣC	0..*	BackboneElement	the superseded DocumentReference resources 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	PatchParameters	Operation Request or Response
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: PATCH
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:Documents	SΣC	1..*	BackboneElement	the Documents 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
entry:FhirDocuments	ΣC	0..*	BackboneElement	the FHIR-FhirDocuments 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	Bundle	Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: transaction http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.request.method	required	Pattern: PATCH http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Documents.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Folders.request.method	required	MHDprovideFolderActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovideFolderActions

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle, Bundle.entry:FhirDocuments.resource	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle, Bundle.entry:FhirDocuments.resource	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle, Bundle.entry:FhirDocuments.resource	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle, Bundle.entry:FhirDocuments.resource	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	A resource should have narrative for robust management : text.`div`.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()
lst-1	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	ComprehensiveProvideDocumentBundle	CH MHD Provide Document Bundle Comprehensive bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:comprehensiveMetadata	SΣ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
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. Required Pattern: transaction
timestamp	Σ	0..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	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	Σ	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
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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
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	SΣ	0..1	Resource	A resource in the bundle
search	Σ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	Σ	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)
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:SubmissionSet	SΣC	1..1	BackboneElement	the SubmissionSet 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SC	1..1	CHMhdSubmissionSetComprehensive	A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:DocumentRefs	SΣC	1..*	BackboneElement	the DocumentReference resources 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	CHMhdDocumentReferenceComprehensive	CH MHD DocumentReference Comprehensive
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:UpdateDocumentRefs	ΣC	0..*	BackboneElement	the superseded DocumentReference resources 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	PatchParameters	Operation Request or Response
search	Σ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	Σ	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)
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: PATCH
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:Documents	SΣC	1..*	BackboneElement	the Documents 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	Binary	Pure binary content defined by a format other than FHIR
search	Σ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	Σ	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)
request	SΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	SΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
entry:FhirDocuments	ΣC	0..*	BackboneElement	the FHIR-FhirDocuments 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	C	1..1	Bundle	Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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
search	Σ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	Σ	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)
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history)
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
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
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
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Bundle.type	required	Pattern: transaction http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:SubmissionSet.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:DocumentRefs.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:UpdateDocumentRefs.request.method	required	Pattern: PATCH http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Documents.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Documents.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:FhirDocuments.request.method	required	Pattern: POST http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:Folders.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Folders.request.method	required	MHDprovideFolderActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovideFolderActions
Bundle.entry:Patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:Patient.request.method	required	MHDprovidePatientActions https://profiles.ihe.net/ITI/MHD/ValueSet/MHDprovidePatientActions

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle, Bundle.entry:FhirDocuments.resource	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle, Bundle.entry:FhirDocuments.resource	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle, Bundle.entry:FhirDocuments.resource	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:SubmissionSet, Bundle.entry:DocumentRefs, Bundle.entry:UpdateDocumentRefs, Bundle.entry:Documents, Bundle.entry:FhirDocuments	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle, Bundle.entry:FhirDocuments.resource	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, Bundle.entry:FhirDocuments.resource	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle, Bundle.entry:FhirDocuments.resource	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle, Bundle.entry:FhirDocuments.resource	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:SubmissionSet.resource, Bundle.entry:DocumentRefs.resource, Bundle.entry:Folders.resource, Bundle.entry:Patient.resource	A resource should have narrative for robust management : text.`div`.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()
lst-1	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	Bundle.entry:SubmissionSet.resource, Bundle.entry:Folders.resource	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from ComprehensiveProvideDocumentBundle

Summary

Mandatory: 10 elements
Must-Support: 14 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• CH MHD SubmissionSet Comprehensive (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive)
• CH MHD DocumentReference Comprehensive (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive)

Slices

This structure defines the following Slices:

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