This page is part of the Loinc/IVD Mapping FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

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

Resource Profile: LIVD Bundle

LIVD constraints on the Bundle resource

Usage:

• Examples for this Resource Profile: Bundle/livd-example-abbott-architect, Bundle/livd-example-roche-qual, Bundle/livd-example-roche-quant and Bundle/livd-example

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		0..*	Bundle	LIVDBundle
identifier	S	1..1	Identifier	Persistent identifier for the bundle
type	S	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
timestamp		0..0
total		0..0
link		0..0
entry	S	5..*	BackboneElement	Entry in the bundle - will have a resource or information
link		0..0
fullUrl	S	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	Resource	A resource in the bundle
search		0..0
request	S	0..1	BackboneElement	Transaction Related Information
method	S	1..1	code	GET | POST | PUT | DELETE
url	S	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		0..0
signature		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Bundle.type	required	LivdBundleTypeVS

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	LIVDBundle
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
entry	SΣC	5..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SΣ	1..1	Resource	A resource in the bundle
request	SΣC	0..1	BackboneElement	Transaction Related Information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.type	required	LivdBundleTypeVS
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	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	LIVDBundle
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
entry	SΣC	5..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SΣ	1..1	Resource	A resource in the bundle
request	SΣC	0..1	BackboneElement	Transaction 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
method	SΣ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	LivdBundleTypeVS
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	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: 2 elements
Must-Support: 8 elements
Prohibited: 7 elements

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	Bundle	LIVDBundle
identifier	S	1..1	Identifier	Persistent identifier for the bundle
type	S	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
timestamp		0..0
total		0..0
link		0..0
entry	S	5..*	BackboneElement	Entry in the bundle - will have a resource or information
link		0..0
fullUrl	S	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	Resource	A resource in the bundle
search		0..0
request	S	0..1	BackboneElement	Transaction Related Information
method	S	1..1	code	GET | POST | PUT | DELETE
url	S	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		0..0
signature		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Bundle.type	required	LivdBundleTypeVS

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	LIVDBundle
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
entry	SΣC	5..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SΣ	1..1	Resource	A resource in the bundle
request	SΣC	0..1	BackboneElement	Transaction Related Information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	SΣ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.type	required	LivdBundleTypeVS
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	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	LIVDBundle
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	The bundle type Binding: Allowed types of bundles for the LIVD catalog (required): Allowed types of bundles for the LIVD catalog
entry	SΣC	5..*	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	SΣ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	SΣ	1..1	Resource	A resource in the bundle
request	SΣC	0..1	BackboneElement	Transaction 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
method	SΣ	1..1	code	GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	LivdBundleTypeVS
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry	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: 2 elements
Must-Support: 8 elements
Prohibited: 7 elements

Other representations of profile: CSV, Excel, Schematron