Implementation Guide
ePA MHD Service
Version 1.1.0 - release

## Resource Profile: EPA Document Search Result Bundle

Official URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-document-search-result-bundle | Version: 1.1.0
Active as of 2025-12-15 | Computable Name: EPADocumentSearchResultBundle
Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

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

Usages:

- Examples for this Profile: Bundle/example-fulltext-search-match
- CapabilityStatements using this Profile: EPA MHD Service (Document Consumer - Client) and ePA MHD Service (Document Responder - Server)

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
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
link | S Σ | 0..* | BackboneElement | Links related to this Bundle
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-8, bdl-5 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
search | Σ C | 0..1 | BackboneElement | Search related information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
request | Σ C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history)
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
response | Σ C | 0..1 | BackboneElement | Results of execution (transaction/batch/history)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status | Σ | 1..1 | string | Status response code (text optional)
entry:documentReference | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-8, bdl-5 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 |  |  |  | Content/Rules for all slices
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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.
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:documentReference.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:documentReference.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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:documentReference | 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:documentReference | 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Slices for entry |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
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 |  |  |  | Content/Rules for all slices
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 |  | Additional execution information (transaction/batch/history)
response |  | 0..0 |  | Results of execution (transaction/batch/history)
signature |  | 0..0 |  | Digital Signature
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 Slice: Unordered, Open by value:url
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-8, bdl-5 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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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-8, bdl-5 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 Slice: Unordered, Open by value:url
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 | Additional content defined by implementations 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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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:documentReference.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:documentReference.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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:documentReference | 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:documentReference | 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: 0 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- EPA MHD DocumentReference (https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference)

Extensions

This structure refers to these extensions:

- https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
- https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits

Slices

This structure defines the following Slices:

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

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
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
link | S Σ | 0..* | BackboneElement | Links related to this Bundle
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-8, bdl-5 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
search | Σ C | 0..1 | BackboneElement | Search related information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
request | Σ C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history)
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
response | Σ C | 0..1 | BackboneElement | Results of execution (transaction/batch/history)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status | Σ | 1..1 | string | Status response code (text optional)
entry:documentReference | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-8, bdl-5 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 |  |  |  | Content/Rules for all slices
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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.
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:documentReference.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:documentReference.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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:documentReference | 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:documentReference | 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Slices for entry |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
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 |  |  |  | Content/Rules for all slices
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 |  | Additional execution information (transaction/batch/history)
response |  | 0..0 |  | Results of execution (transaction/batch/history)
signature |  | 0..0 |  | Digital Signature
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 Slice: Unordered, Open by value:url
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-8, bdl-5 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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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 Slice: Unordered, Open by value:url
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-8, bdl-5 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 Slice: Unordered, Open by value:url
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 | Additional content defined by implementations 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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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 |  | Extension Slice: Unordered, Open by value:url
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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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:documentReference.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:documentReference.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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:documentReference | 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:documentReference | 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: 0 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- EPA MHD DocumentReference (https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference)

Extensions

This structure refers to these extensions:

- https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-snippet
- https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-match-total-hits

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