HL7.FHIR.UV.LIVD\LIVD Bundle

LOINC – IVD Test Code (LIVD) Mapping
0.3.0 - ballot

LOINC – IVD Test Code (LIVD) Mapping, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version 0.3.0). This version is based on the current content of https://github.com/HL7/livd/ and changes regularly. See the Directory of published versions

Resource Profile: LIVD Bundle

Defining URL:

http://hl7.org/fhir/uv/livd/StructureDefinition/bundle-uv-livd

Version:

0.3.0

Name:

LIVDBundle

Status:

Draft as of 8/14/18

Definition:

LIVD constraints on the Bundle resource

Publisher:

HL7 International - Orders and Observations Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/livd/StructureDefinition/bundle-uv-livd

Description

The LIVD Bundle is a profile on the Bundle resource to include all the necessary resources to express the LIVD catalog.

Formal Views of Profile Content

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

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

This structure is derived from Bundle

Summary

Mandatory: 2 elements
Must-Support: 8 elements
Prohibited: 7 elements

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	6..*	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

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	LIVDBundle
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
identifier	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ΣI	6..*	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ΣI	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

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	LIVDBundle
identifier	Σ	1..1	Identifier	Persistent identifier for the bundle
type	Σ	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	ΣI	6..*	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
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Resource	A resource in the bundle
request	ΣI	0..1	BackboneElement	Transaction Related Information
method	Σ	1..1	code	GET \| POST \| PUT \| DELETE 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
Documentation for this format

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	6..*	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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*	Bundle	LIVDBundle
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
identifier	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ΣI	6..*	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ΣI	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

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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

Constraints

Id	Grade	Path	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-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-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	Bundle.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.link.relation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.link.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
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-8	error	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
ele-1	error	Bundle.entry	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.fullUrl	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.search.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.search.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.search.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.search.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.search.mode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.search.score	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.request.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.request.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.request.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.request.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.ifNoneMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.ifModifiedSince	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.ifMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.request.ifNoneExist	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.response.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.response.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.response.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.response.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Bundle.entry.response.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.response.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.response.etag	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Bundle.entry.response.lastModified	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 International - Orders and Observations Work Group. Package hl7.fhir.uv.livd#0.3.0 based on FHIR 4.0.1. Generated 2022-01-23
Links: Table of Contents | QA Report | Version History | Search | | Propose a change