Bundle für Suchergebnisse

Metadaten

Canonicalhttps://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse
Statusactive
Version5.1.0
Basishttp://hl7.org/fhir/StructureDefinition/Bundle

Inhalt

idS Σ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ C1..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ0..1uri
resourceΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlS Σ1..1uri
resourceS C1..1ISiKDokumentenMetadaten
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ISiKDokumentenSuchergebnisse" />
<url value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse" />
<version value="5.1.0" />
<name value="ISiKDokumentenSuchergebnisse" />
<title value="Suchergebnisse einer Dokumentensuche" />
<status value="active" />
<experimental value="false" />
<date value="2025-10-23" />
<publisher value="gematik GmbH" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<element id="Bundle.id">
<path value="Bundle.id" />
<short value="serverseitige, interne ID des Datensatzes" />
<comment value="**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen." />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.versionId">
<path value="Bundle.meta.versionId" />
<short value="Eindeutiger Name der serverseitigen Version des Datensatzes" />
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen." />
</element>
<element id="Bundle.meta.lastUpdated">
<path value="Bundle.meta.lastUpdated" />
<short value="Zeitpunkt der letzten Änderung" />
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen." />
</element>
<element id="Bundle.type">
<path value="Bundle.type" />
<short value="Bundle-Typ" />
<comment value="Fix: `searchset`" />
<fixedCode value="searchset" />
<mustSupport value="true" />
</element>
<element id="Bundle.total">
<path value="Bundle.total" />
<short value="Gesamtzahl der Suchtreffer" />
<comment value="Gesamtzahl der Suchtreffer auf dem Server, unabhängig vom Page-Size des aktuellen Bundles" />
<min value="1" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<type value="profile" />
<path value="resource" />
</discriminator>
<rules value="open" />
</slicing>
<short value="Ergebnisse der Dokumentensuche" />
<comment value="Jedes Suchergebnis wird in einer separaten `entry` abgebildet. Bundles mit `total = 0` haben keine `entry`" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:DocumentReference">
<path value="Bundle.entry" />
<sliceName value="DocumentReference" />
<short value="Suchergebnis" />
<min value="0" />
<max value="*" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:DocumentReference.fullUrl">
<path value="Bundle.entry.fullUrl" />
<short value="Serverseitige URL der Ressource" />
<comment value="Serverseitige URL der Ressource in `entry.resource`" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:DocumentReference.resource">
<path value="Bundle.entry.resource" />
<short value="Eingebettete Ressource" />
<comment value="Eingebettete Ressource (hier: DocumentReference, die den Suchkriterien entspricht)" />
<min value="1" />
<code value="DocumentReference" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten" />
</type>
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "ISiKDokumentenSuchergebnisse",
"url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse",
"version": "5.1.0",
"name": "ISiKDokumentenSuchergebnisse",
"title": "Suchergebnisse einer Dokumentensuche",
"status": "active",
"experimental": false,
"date": "2025-10-23",
"publisher": "gematik GmbH",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"element": [
{
"id": "Bundle.id",
"path": "Bundle.id",
"short": "serverseitige, interne ID des Datensatzes",
"comment": "**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen.",
"mustSupport": true
},
{
"id": "Bundle.meta.versionId",
"path": "Bundle.meta.versionId",
"short": "Eindeutiger Name der serverseitigen Version des Datensatzes",
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen."
},
{
"id": "Bundle.meta.lastUpdated",
"path": "Bundle.meta.lastUpdated",
"short": "Zeitpunkt der letzten Änderung",
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen."
},
{
"id": "Bundle.type",
"path": "Bundle.type",
"short": "Bundle-Typ",
"comment": "Fix: `searchset`",
"fixedCode": "searchset",
"mustSupport": true
},
{
"id": "Bundle.total",
"path": "Bundle.total",
"short": "Gesamtzahl der Suchtreffer",
"comment": "Gesamtzahl der Suchtreffer auf dem Server, unabhängig vom Page-Size des aktuellen Bundles",
"min": 1
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"slicing": {
{
"type": "profile",
"path": "resource"
}
],
"rules": "open"
},
"short": "Ergebnisse der Dokumentensuche",
"comment": "Jedes Suchergebnis wird in einer separaten `entry` abgebildet. Bundles mit `total = 0` haben keine `entry`",
"mustSupport": true
},
{
"id": "Bundle.entry:DocumentReference",
"path": "Bundle.entry",
"sliceName": "DocumentReference",
"short": "Suchergebnis",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"id": "Bundle.entry:DocumentReference.fullUrl",
"path": "Bundle.entry.fullUrl",
"short": "Serverseitige URL der Ressource",
"comment": "Serverseitige URL der Ressource in `entry.resource`",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry:DocumentReference.resource",
"path": "Bundle.entry.resource",
"short": "Eingebettete Ressource",
"comment": "Eingebettete Ressource (hier: DocumentReference, die den Suchkriterien entspricht)",
"min": 1,
"type": [
{
"code": "DocumentReference",
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
]
}
],
"mustSupport": true
}
]
}
}

Anmerkungen zu Must-Support-Feldern

FeldnameKurzbeschreibungHinweise
Bundle.idserverseitige, 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.typeBundle-Typ

Fix: searchset

Bundle.entryErgebnisse der Dokumentensuche

Jedes Suchergebnis wird in einer separaten entry abgebildet. Bundles mit total = 0 haben keine entry

Bundle.entry:DocumentReferenceSuchergebnis
Bundle.entry:DocumentReference.fullUrlServerseitige URL der Ressource

Serverseitige URL der Ressource in entry.resource

Bundle.entry:DocumentReference.resourceEingebettete Ressource

Eingebettete Ressource (hier: DocumentReference, die den Suchkriterien entspricht)

Interaktionen

siehe Dokumentenabfrage: Interaktion: Dokumentenabfrage und -Zugriff

Beispiele

Suchergebnis mit einem Treffer

Bundle
<Bundle xmlns="http://hl7.org/fhir">
<id value="Suchergebnis-Beispiel" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse" />
</meta>
<type value="searchset" />
<total value="1" />
<relation value="self" />
<url value="http://meinfhirserver.de/DocumentReference?patient.identifier=A123456789" />
</link>
<fullUrl value="http://meinfhirserver.de/DocumentReference/dok-beispiel-server" />
<DocumentReference>
<id value="dok-beispiel-server" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten" />
<system value="http://terminology.hl7.org/CodeSystem/v3-ActReason" />
<code value="HTEST" />
</security>
</meta>
<system value="urn:ietf:rfc:3986" />
<value value="urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340" />
</masterIdentifier>
<status value="current" />
<system value="http://dvmd.de/fhir/CodeSystem/kdl" />
<code value="PT130102" />
<display value="Molekularpathologiebefund" />
</coding>
<system value="http://ihe-d.de/CodeSystems/IHEXDStypeCode" />
<code value="PATH" />
<display value="Pathologiebefundberichte" />
</coding>
</type>
<system value="http://ihe-d.de/CodeSystems/IHEXDSclassCode" />
<code value="BEF" />
<display value="Befundbericht" />
</coding>
</category>
<reference value="Patient/PatientinMusterfrau" />
</subject>
<system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality" />
<code value="N" />
</coding>
</securityLabel>
<contentType value="application/pdf" />
<language value="de" />
<url value="https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf" />
<title value="Molekularpathologiebefund vom 31.12.21" />
<creation value="2020-12-31T23:50:50-05:00" />
</attachment>
<system value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode" />
<code value="urn:ihe:iti:xds:2017:mimeTypeSufficient" />
<display value="Format aus MIME Type ableitbar" />
</format>
</content>
<reference value="Encounter/FachabteilungskontaktNormal" />
</encounter>
<system value="http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung" />
<code value="KHS" />
<display value="Krankenhaus" />
</coding>
</facilityType>
<system value="http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen" />
<code value="ALLG" />
</coding>
</practiceSetting>
</context>
</DocumentReference>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "Suchergebnis-Beispiel",
"meta": {
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse"
]
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "http://meinfhirserver.de/DocumentReference?patient.identifier=A123456789"
}
],
"entry": [
{
"fullUrl": "http://meinfhirserver.de/DocumentReference/dok-beispiel-server",
"resourceType": "DocumentReference",
"id": "dok-beispiel-server",
"meta": {
{
"code": "HTEST",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActReason"
}
],
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
]
},
"type": {
"coding": [
{
"system": "http://dvmd.de/fhir/CodeSystem/kdl",
"code": "PT130102",
"display": "Molekularpathologiebefund"
},
{
"system": "http://ihe-d.de/CodeSystems/IHEXDStypeCode",
"code": "PATH",
"display": "Pathologiebefundberichte"
}
]
},
{
"coding": [
{
"system": "http://ihe-d.de/CodeSystems/IHEXDSclassCode",
"code": "BEF",
"display": "Befundbericht"
}
]
}
],
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340"
},
"status": "current",
"subject": {
"reference": "Patient/PatientinMusterfrau"
},
{
"coding": [
{
"code": "N",
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality"
}
]
}
],
"content": [
{
"contentType": "application/pdf",
"url": "https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf",
"language": "de",
"title": "Molekularpathologiebefund vom 31.12.21",
"creation": "2020-12-31T23:50:50-05:00"
},
"format": {
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"system": "http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode",
"display": "Format aus MIME Type ableitbar"
}
}
],
"context": {
"coding": [
{
"code": "KHS",
"system": "http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung",
"display": "Krankenhaus"
}
]
},
"coding": [
{
"code": "ALLG",
"system": "http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen"
}
]
},
{
"reference": "Encounter/FachabteilungskontaktNormal"
}
]
}
}
}
]
}