LOINC – IVD Test Code (LIVD) Mapping
1.0.0-ballot - ballot International flag

LOINC – IVD Test Code (LIVD) Mapping, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. 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

Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/bundle-uv-livd Version: 1.0.0-ballot
Draft as of 2018-08-14 Computable Name: LIVDBundle

LIVD constraints on the Bundle resource

Description

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle LIVDBundle
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
... 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
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
ele-1: All FHIR elements must have a @value or children
... 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


ele-1: All FHIR elements must have a @value or children
.... 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 SΣ 0..1 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 SΣ 1..1 Resource A resource in the bundle
.... request SΣC 0..1 BackboneElement Transaction Related Information
ele-1: All FHIR elements must have a @value or children
..... 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
..... method SΣ 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.


ele-1: All FHIR elements must have a @value or children
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
ele-1: All FHIR elements must have a @value or children
..... ifNoneMatch Σ 0..1 string For managing cache currency
ele-1: All FHIR elements must have a @value or children
..... ifModifiedSince Σ 0..1 instant For managing cache currency
ele-1: All FHIR elements must have a @value or children
..... ifMatch Σ 0..1 string For managing update contention
ele-1: All FHIR elements must have a @value or children
..... ifNoneExist Σ 0..1 string For conditional creates
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle LIVDBundle
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 Σ 0..1 Meta Metadata about the resource
... 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 6..* 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle LIVDBundle
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
... 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
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
ele-1: All FHIR elements must have a @value or children
... 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


ele-1: All FHIR elements must have a @value or children
.... 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 SΣ 0..1 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 SΣ 1..1 Resource A resource in the bundle
.... request SΣC 0..1 BackboneElement Transaction Related Information
ele-1: All FHIR elements must have a @value or children
..... 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
..... method SΣ 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.


ele-1: All FHIR elements must have a @value or children
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
ele-1: All FHIR elements must have a @value or children
..... ifNoneMatch Σ 0..1 string For managing cache currency
ele-1: All FHIR elements must have a @value or children
..... ifModifiedSince Σ 0..1 instant For managing cache currency
ele-1: All FHIR elements must have a @value or children
..... ifMatch Σ 0..1 string For managing update contention
ele-1: All FHIR elements must have a @value or children
..... ifNoneExist Σ 0..1 string For conditional creates
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle LIVDBundle
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 Σ 0..1 Meta Metadata about the resource
... 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 6..* 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredLivdBundleTypeVS
http://hl7.org/fhir/uv/livd/ValueSet/livd-bundle-type
from this IG
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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