ISiK Formularmodul Implementation Guide
Version 6.0.0-rc - ci-build

Resource Profile: ISiKBerichtBundle

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtBundle Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiKBerichtBundle

Das Document-Bundle dient dem Transport von Berichten zwischen Subsystemen im Krankenhaus. Das Bundle entspricht den Anforderungen an ein FHIR Document Bundle : Alle referenzierten Ressourcen müssen als Einträge im Bundle enthalten sein. Das Bundle unterstützt die Übermittlung einer menschenlesbaren Dokumentation (Narrative) und erlaubt zudem die Übernahme wichtiger Ressourcen (z. B. Diagnosen und Prozeduren), die einem Patienten und Fall (Patient, Encounter) zugeordnet sind.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, ISiK-docBundle-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Identifier des Berichtsbundles
... timestamp SΣ 1..1 instant Datum des Bundles
... Slices for entry SΣC 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
Constraints: bdl-5, bdl-8
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
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Patient A resource in the bundle
.... entry:Encounter SΣC 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Encounter A resource in the bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)
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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: ISiK-docBundle-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... identifier S 1..1 Identifier Identifier des Berichtsbundles
... timestamp S 1..1 instant Datum des Bundles
... Slices for entry S 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
.... entry:All Slices Content/Rules for all slices
..... fullUrl S 1..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 Search related information
..... request 0..0 Additional execution information (transaction/batch/history)
..... response 0..0 Results of execution (transaction/batch/history)
.... entry:Composition S 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
..... resource 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient S 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
..... resource 1..1 Patient A resource in the bundle
.... entry:Encounter S 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
..... resource 1..1 Encounter A resource in the bundle

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, ISiK-docBundle-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..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 Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* 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
... identifier SΣ 1..1 Identifier Identifier des Berichtsbundles
... type SΣ 1..1 code Typ des Bundles
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣ 1..1 instant Datum des Bundles
... 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
... Slices for entry SΣC 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
Constraints: bdl-5, bdl-8
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
.... entry:All Slices Content/Rules for all slices
..... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Patient A resource in the bundle
.... entry:Encounter SΣC 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Encounter A resource in the bundle
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)
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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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()
ElementShort descriptionNotes
Bundle.entry Eintrag pro Ressource

Begründung MS: Alle im Rahmen des Berichtes relevanten Informationen müssen hier referenziert werden.
Bundle.entry.fullUrl
Bundle.entry.resource
Bundle.entry:Composition Slice zur Hinterlegung einer Composition-Instanz

Dieses Slice wird explizit aufgeführt, um zu verdeutlichen, dass immer eine Composition-Instanz im Bundle enthalten ist. Die FHIR-Core Specification besagt für Document-Bundles bereits, dass die erste Ressource im Bundle eine Composition sein muss. Alle daraus referenzierten Ressourcen müssen ebenfalls Teil des Bundle sein.
Bundle.entry:Encounter Slice zur Hinterlegung einer Encounter-Instanz

Dieses Slice ist optional, aber wenn es vorhanden ist, muss es genau eine Encounter-Instanz sein. Die FHIR-Core Specification besagt für Document-Bundles bereits, dass einige von der Composition referenzierte Ressourcen immer auch im Bundle enthalten sein müssen. Hierzu gehört im ISiK Kontext auch die Encounter-Instanz.
Bundle.entry:Patient Slice zur Hinterlegung einer Patienten-Instanz

Dieses Slice wir explizit aufgeführt, um zu verdeutlichen, dass immer eine Patienten-Instanz im Bundle enthalten ist. Die FHIR-Core Specification besagt für Document-Bundles bereits, dass einige von der Composition referenzierte Ressourcen immer auch im Bundle enthalten sein müssen. Hierzu gehört im ISiK Kontext auch die Patient-Instanz.
Bundle.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.
Bundle.identifier Identifier des Berichtsbundles

Motivation MS: Zur Identifikation des Berichtbundles muss ein Identifier vom Subsystem mit angegeben werden.
Bundle.timestamp Datum des Bundles

Begründung Pflichtfeld: Ein Datum muss für die korrekte Verarbeitung durch das Zielsystem vorhanden sein.
Bundle.type Typ des Bundles

Begründung MS: Damit das Bundle ein Document-Bundle nach FHIR-Core Spec ist, muss der type auf document gesetzt werden.

This structure is derived from Bundle

Summary

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

Structures

This structure refers to these other structures:

  • Unable to summarise profile https://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtSubSysteme (no profile found)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, ISiK-docBundle-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Identifier des Berichtsbundles
... timestamp SΣ 1..1 instant Datum des Bundles
... Slices for entry SΣC 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
Constraints: bdl-5, bdl-8
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
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Patient A resource in the bundle
.... entry:Encounter SΣC 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
Constraints: bdl-5, bdl-8
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Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Encounter A resource in the bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)
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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: ISiK-docBundle-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... identifier S 1..1 Identifier Identifier des Berichtsbundles
... timestamp S 1..1 instant Datum des Bundles
... Slices for entry S 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
.... entry:All Slices Content/Rules for all slices
..... fullUrl S 1..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 Search related information
..... request 0..0 Additional execution information (transaction/batch/history)
..... response 0..0 Results of execution (transaction/batch/history)
.... entry:Composition S 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
..... resource 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient S 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
..... resource 1..1 Patient A resource in the bundle
.... entry:Encounter S 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
..... resource 1..1 Encounter A resource in the bundle

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, ISiK-docBundle-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..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 Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* 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
... identifier SΣ 1..1 Identifier Identifier des Berichtsbundles
... type SΣ 1..1 code Typ des Bundles
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣ 1..1 instant Datum des Bundles
... 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
... Slices for entry SΣC 2..* BackboneElement Eintrag pro Ressource
Slice: Unordered, Open by type:resource
Constraints: bdl-5, bdl-8
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
.... entry:All Slices Content/Rules for all slices
..... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Composition-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 ​?pkp-2? A resource in the bundle
.... entry:Patient SΣC 1..1 BackboneElement Slice zur Hinterlegung einer Patienten-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Patient A resource in the bundle
.... entry:Encounter SΣC 0..1 BackboneElement Slice zur Hinterlegung einer Encounter-Instanz
Constraints: bdl-5, bdl-8
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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ 1..1 Encounter A resource in the bundle
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:Encounter.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-docBundle-1 error Bundle All referenced Resources must be contained in the Bundle Bundle.entry.descendants().reference.distinct().subsetOf(%context.entry.fullUrl)
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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Encounter 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: 5 elements(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

  • Unable to summarise profile https://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtSubSysteme (no profile found)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron