Bundle für Suchergebnisse
Suchergebnisse einer Dokumentensuche
Metadaten
| Canonical | https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse |
|---|---|
| Status | active |
| Version | 5.1.0 |
| Basis | http://hl7.org/fhir/StructureDefinition/Bundle |
Inhalt
| ISiKDokumentenSuchergebnisse (Bundle) | C | Bundle | |
| id | S Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 0..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| identifier | Σ | 0..1 | Identifier |
| type | S Σ | 1..1 | codeBindingFixed Value |
| timestamp | Σ | 0..1 | instant |
| total | Σ C | 1..1 | unsignedInt |
| link | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| relation | Σ | 1..1 | string |
| url | Σ | 1..1 | uri |
| entry | S Σ C | 0..* | BackboneElement |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | Σ | 0..1 | Resource |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBinding |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| DocumentReference | S Σ C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | S Σ | 1..1 | uri |
| resource | S C | 1..1 | ISiKDokumentenMetadaten |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBinding |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| signature | Σ | 0..1 | Signature |
<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." />
</element>
<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>
<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>
<comment value="Gesamtzahl der Suchtreffer auf dem Server, unabhängig vom Page-Size des aktuellen Bundles" />
</element>
</discriminator>
</slicing>
<comment value="Jedes Suchergebnis wird in einer separaten `entry` abgebildet. Bundles mit `total = 0` haben keine `entry`" />
</element>
</element>
</element>
<comment value="Eingebettete Ressource (hier: DocumentReference, die den Suchkriterien entspricht)" />
</type>
</element>
</differential>
</StructureDefinition>
{
{
"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.",
},
{
"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."
},
{
"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."
},
{
},
{
"comment": "Gesamtzahl der Suchtreffer auf dem Server, unabhängig vom Page-Size des aktuellen Bundles",
},
{
},
"comment": "Jedes Suchergebnis wird in einer separaten `entry` abgebildet. Bundles mit `total = 0` haben keine `entry`",
},
{
},
{
},
{
{
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
]
}
],
}
]
}
}
Anmerkungen zu Must-Support-Feldern
| Feldname | Kurzbeschreibung | Hinweise |
|---|---|---|
| Bundle.id | serverseitige, interne ID des Datensatzes | bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine |
| Bundle.type | Bundle-Typ | Fix: |
| Bundle.entry | Ergebnisse der Dokumentensuche | Jedes Suchergebnis wird in einer separaten |
| Bundle.entry:DocumentReference | Suchergebnis | |
| Bundle.entry:DocumentReference.fullUrl | Serverseitige URL der Ressource | Serverseitige URL der Ressource in |
| Bundle.entry:DocumentReference.resource | Eingebettete Ressource | Eingebettete Ressource (hier: DocumentReference, die den Suchkriterien entspricht) |
Interaktionen
siehe Dokumentenabfrage: Interaktion: Dokumentenabfrage und -Zugriff
Beispiele
Suchergebnis mit einem Treffer
| 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 |
| resource |
| id : dok-beispiel-server |
| meta |
| profile : https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten |
| security |
| system : http://terminology.hl7.org/CodeSystem/v3-ActReason |
| code : HTEST |
| masterIdentifier |
| 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 |
| type |
| coding |
| system : http://dvmd.de/fhir/CodeSystem/kdl |
| code : PT130102 |
| display : Molekularpathologiebefund |
| coding |
| system : http://ihe-d.de/CodeSystems/IHEXDStypeCode |
| code : PATH |
| display : Pathologiebefundberichte |
| category |
| coding |
| system : http://ihe-d.de/CodeSystems/IHEXDSclassCode |
| code : BEF |
| display : Befundbericht |
| subject |
| reference : Patient/PatientinMusterfrau |
| securityLabel |
| coding |
| system : http://terminology.hl7.org/CodeSystem/v3-Confidentiality |
| code : N |
| content |
| attachment |
| contentType : application/pdf |
| language : de |
| url : https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf |
| title : Molekularpathologiebefund vom 31.12.21 |
| creation : 2020-12-31T23:50:50-05:00 |
| format |
| system : http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode |
| code : urn:ihe:iti:xds:2017:mimeTypeSufficient |
| display : Format aus MIME Type ableitbar |
| context |
| encounter |
| reference : Encounter/FachabteilungskontaktNormal |
| facilityType |
| coding |
| system : http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung |
| code : KHS |
| display : Krankenhaus |
| practiceSetting |
| coding |
| system : http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen |
| code : ALLG |
</meta>
</link>
<DocumentReference>
</security>
</meta>
</masterIdentifier>
</coding>
</coding>
</type>
</coding>
</category>
</subject>
</coding>
</securityLabel>
<url value="https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf" />
</attachment>
</format>
</content>
</encounter>
</coding>
</facilityType>
</coding>
</practiceSetting>
</context>
</DocumentReference>
</resource>
</entry>
</Bundle>
{
},
{
}
],
{
],
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
]
},
{
},
{
}
]
},
{
{
}
]
}
],
},
},
{
}
],
{
"url": "https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf",
},
}
}
],
{
}
]
},
},
]
}
}
}
]
}