This page is part of the Loinc/IVD Mapping FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

This is a pre-release version (Draft for Comment) of Loinc/IVD Mapping (LIVD) R1 (STU). There is no current official version.
For a full list of available versions, see the Directory of published versions .

StructureDefinition: LIVD Bundle

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 3 elements (5 nested mandatory elements)
Must-Support: 1 element
Prohibited: 8 elements

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*LIVD Bundle
... identifier 1..1IdentifierPersistent identifier for the bundle
... type 1..1codecollection
... timestamp 0..0
... total 0..0
... link 0..0
... entry 5..*BackboneElementEntry in the bundle - will have a resource, or information
.... link 0..0
.... fullUrl 0..0
.... resource S1..1ResourceA resource in the bundle
.... search 0..0
.... request 0..0
.... response 0..0
... signature 0..1SignatureDigital Signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*LIVD Bundle
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... identifier Σ1..1IdentifierPersistent identifier for the bundle
... type Σ1..1codecollection
Binding: BundleType (required)
... entry ΣI5..*BackboneElementEntry 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... resource SΣ1..1ResourceA resource in the bundle
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 3 elements (5 nested mandatory elements)
Must-Support: 1 element
Prohibited: 8 elements

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*LIVD Bundle
... identifier 1..1IdentifierPersistent identifier for the bundle
... type 1..1codecollection
... timestamp 0..0
... total 0..0
... link 0..0
... entry 5..*BackboneElementEntry in the bundle - will have a resource, or information
.... link 0..0
.... fullUrl 0..0
.... resource S1..1ResourceA resource in the bundle
.... search 0..0
.... request 0..0
.... response 0..0
... signature 0..1SignatureDigital Signature

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*LIVD Bundle
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... identifier Σ1..1IdentifierPersistent identifier for the bundle
... type Σ1..1codecollection
Binding: BundleType (required)
... entry ΣI5..*BackboneElementEntry 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... resource SΣ1..1ResourceA resource in the bundle
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Bundle.languageLanguagepreferredCommon Languages
Bundle.typeBundleTyperequiredBundleType
Bundle.entry.search.modeSearchEntryModerequiredSearchEntryMode
Bundle.entry.request.methodHTTPVerbrequiredHTTPVerb

Constraints

IdPathDetailsRequirements
bdl-7BundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
: entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9BundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-3Bundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4Bundleentry.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-12BundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-11BundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-10BundleA document must have a date
: type = 'document' implies (meta.lastUpdated.hasValue())
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()