Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Nphies Bundle

Bundle Profile

Usage:

• Examples for this Resource Profile: Bundle/06b80922-b538-4ab3-9176-a80b51249001, Bundle/4350490e-98f0-4c23-9e7d-4cd2c7011959, Bundle/43c68545-8e37-4744-b8ea-9a1e3c1ada84, Bundle/96b80922-b538-4ab3-0176-a80b51242161... Show 15 more, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7383, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7aa1, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7aa2, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7aa3, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7aad, Bundle/a84aabfa-1163-407d-aa38-f8119a0b7aee, Bundle/a84aabfa-1163-407d-aa38-f8119a0b8888, Bundle/c2c63768-a65b-4784-ab91-6c09012c3ab1, Bundle/c2c63768-a65b-4784-ab91-6c09012c3abd, Bundle/c2c63768-a65b-4784-ab91-6c09012c3aca, Bundle/c2c63768-a65b-4784-ab91-6c09012c3acb, Bundle/c2c63768-a65b-4784-ab91-6c09012c3aee, Bundle/c2c63768-a65b-4784-ab91-6c09012c3cbc, Bundle/c2c63768-a65b-5784-ab91-6c09012c3cbc and Bundle/dccc9ae9-e640-4fe1-b3fd-5af3c1c12210

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 Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id		1..1	id	Logical id of this artifact Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
type		1..1	DP_code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: message
timestamp		1..1	DP_instant	When the bundle was assembled
entry		1..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl		1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	Resource	A resource in the bundle
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	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 BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	DP_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. ele-1: All FHIR elements must have a @value or children Required Pattern: message
timestamp	Σ	1..1	DP_instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fullUrl	Σ	1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID) ele-1: All FHIR elements must have a @value or children
resource	Σ	1..1	Resource	A resource in the bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	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 BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id	Σ	1..1	id	Logical id of this artifact Max Length:64
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
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
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	DP_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: message
timestamp	Σ	1..1	DP_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
entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..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)
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: message 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

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_instant (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-instant)
• DP_uri (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-uri)

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id		1..1	id	Logical id of this artifact Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
type		1..1	DP_code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: message
timestamp		1..1	DP_instant	When the bundle was assembled
entry		1..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl		1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	Resource	A resource in the bundle
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	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 BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	DP_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. ele-1: All FHIR elements must have a @value or children Required Pattern: message
timestamp	Σ	1..1	DP_instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fullUrl	Σ	1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID) ele-1: All FHIR elements must have a @value or children
resource	Σ	1..1	Resource	A resource in the bundle
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: message http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	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 BV-00126: The Bundle first entry is not a MessageHeader resource. BV-00130: The provided bundle type is invalid It must be 'message'. BV-00341: Bundle ID is not a valid GUID.
id	Σ	1..1	id	Logical id of this artifact Max Length:64
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
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
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	DP_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: message
timestamp	Σ	1..1	DP_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
entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	1..1	DP_uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..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)
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: message 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

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00126	error	Bundle	The Bundle first entry is not a MessageHeader resource. : entry.first().resource.ofType(MessageHeader)
BV-00130	error	Bundle	The provided bundle type is invalid It must be 'message'. : type.exists() implies type = 'message'
BV-00341	error	Bundle	Bundle ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_instant (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-instant)
• DP_uri (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-uri)

Other representations of profile: CSV, Excel, Schematron