Implementation Guide
ePA MHD Service
Version 1.0.1-b.1 - ballot

Resource Profile: EPA Document Search Result Bundle

Official URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-document-search-result-bundle Version: 1.0.1-b.1
Draft as of 2025-07-15 Computable Name: EPADocumentSearchResultBundle

Dieses Profil stellt Suchergebnisse nach Dokumenten inklusive Metadaten und ggf. nach einer Volltextsuche dar.

Usages:

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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: searchset
... total SΣC 0..1 unsignedInt If search, the total number of matches
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation SΣ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url SΣ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:documentReference SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search SΣC 1..1 BackboneElement Search related information
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ Slices for extension Content/Rules for all slices
......... extension:snippet S 0..1 Extension Extension
.......... extension 0..0
.......... url 1..1 uri "snippet"
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... extension 0..0
.......... url 1..1 uri "pageNumber"
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet"
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ extension 0..0
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits"
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode SΣ 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score SΣ 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.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.entry, Bundle.entry:documentReferencemust 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.entry, Bundle.entry:documentReferencefullUrl 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: searchset
... total S 0..1 unsignedInt If search, the total number of matches
... link S 0..* BackboneElement Links related to this Bundle
.... relation S 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url S 1..1 uri Reference details for the link
.... entry:documentReference S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search S 1..1 BackboneElement Search related information
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ Slices for extension Content/Rules for all slices
......... extension:snippet S 0..1 Extension Extension
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... mode S 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
...... score S 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.
..... request 0..0
..... response 0..0
... signature 0..0

doco Documentation for this format
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
... 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 Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total SΣC 0..1 unsignedInt If search, the total number of matches
... link SΣ 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 SΣ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url SΣ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search 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
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... 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 Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
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
...... 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 ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... 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
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:documentReference SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search SΣC 1..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
......... extension:snippet S 0..1 Extension Extension
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..0
.......... url 1..1 uri "snippet"
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..0
.......... url 1..1 uri "pageNumber"
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet"
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits"
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode SΣ 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score SΣ 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
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
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.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.entry, Bundle.entry:documentReferencemust 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.entry, Bundle.entry:documentReferencefullUrl 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: 0 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: searchset
... total SΣC 0..1 unsignedInt If search, the total number of matches
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation SΣ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url SΣ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:documentReference SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search SΣC 1..1 BackboneElement Search related information
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ Slices for extension Content/Rules for all slices
......... extension:snippet S 0..1 Extension Extension
.......... extension 0..0
.......... url 1..1 uri "snippet"
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... extension 0..0
.......... url 1..1 uri "pageNumber"
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet"
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ extension 0..0
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits"
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode SΣ 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score SΣ 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.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.entry, Bundle.entry:documentReferencemust 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.entry, Bundle.entry:documentReferencefullUrl 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()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: searchset
... total S 0..1 unsignedInt If search, the total number of matches
... link S 0..* BackboneElement Links related to this Bundle
.... relation S 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url S 1..1 uri Reference details for the link
.... entry:documentReference S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search S 1..1 BackboneElement Search related information
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ Slices for extension Content/Rules for all slices
......... extension:snippet S 0..1 Extension Extension
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... mode S 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
...... score S 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.
..... request 0..0
..... response 0..0
... signature 0..0

doco Documentation for this format

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
... 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 Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total SΣC 0..1 unsignedInt If search, the total number of matches
... link SΣ 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 SΣ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url SΣ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search 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
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... 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 Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
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
...... 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 ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... 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
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:documentReference SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAMHDDocumentReference A reference to a document
..... search SΣC 1..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:matchSnippet S 0..* (Complex) EPA Match Snippet Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
......... extension:snippet S 0..1 Extension Extension
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..0
.......... url 1..1 uri "snippet"
.......... value[x] S 1..1 string Menschenlesbarer Textausschnitt, der den Kontext des Suchtreffers beschreibt
......... extension:pageNumber S 0..1 Extension Extension
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..0
.......... url 1..1 uri "pageNumber"
.......... value[x] S 1..1 string Bei Dokumenten mit Seitennummerierung (z.B. PDF) lässt sich hier die genaue Trefferseite der Volltextsuche angeben.
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet"
....... extension:totalHits S 0..1 (Complex) EPA Match Total Hits Extension
URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits"
........ value[x] S 1..1 integer Gesamtanzahl der in diesem Dokument gefundenen Treffer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode SΣ 1..1 code Gibt an, wie ein Dokument in das Suchergebnis der Volltextsuche aufgenommen wurde (d.h. direkt als Treffer, durch Beziehung oder als zusätzliche Information).
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score SΣ 1..1 decimal Bewertet die Relevanz eines Dokuments für die Suchanfrage basierend auf einem berechneten Relevanzwert.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
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
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.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.entry, Bundle.entry:documentReferencemust 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.entry, Bundle.entry:documentReferencefullUrl 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: 0 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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